Activities as defined in section 3.2 of RFC 4480
This value is not defined in the RFC, it corresponds to no activity with a basic status of "closed".
This value is not defined in the RFC, it corresponds to no activity with a basic status of "open".
The person has a calendar appointment, without specifying exactly of what type. This activity is indicated if more detailed information is not available or the person chooses not to reveal more information.
The person is physically away from all interactive communication devices.
The person is eating the first meal of the day, usually eaten in the morning.
The person is busy, without further details.
The person is having his or her main meal of the day, eaten in the evening or at midday.
This is a scheduled national or local holiday.
The person is riding in a vehicle, such as a car, but not steering.
The person is looking for (paid) work.
The person is eating his or her midday meal.
The person is scheduled for a meal, without specifying whether it is breakfast, lunch, or dinner, or some other meal.
The person is in an assembly or gathering of people, as for a business, social, or religious purpose. A meeting is a sub-class of an appointment.
The person is talking on the telephone.
The person is engaged in an activity with no defined representation. A string describing the activity in plain text SHOULD be provided.
A performance is a sub-class of an appointment and includes musical, theatrical, and cinematic performances as well as lectures. It is distinguished from a meeting by the fact that the person may either be lecturing or be in the audience, with a potentially large number of other people, making interruptions particularly noticeable.
The person will not return for the foreseeable future, e.g., because it is no longer working for the company.
The person is occupying himself or herself in amusement, sport, or other recreation.
The person is giving a presentation, lecture, or participating in a formal round-table discussion.
The person is visiting stores in search of goods or services.
The person is sleeping.
The person is observing an event, such as a sports event.
The person is controlling a vehicle, watercraft, or plane.
The person is on a business or personal trip, but not necessarily in-transit.
The person is watching television.
The activity of the person is unknown.
A period of time devoted to pleasure, rest, or relaxation.
The person is engaged in, typically paid, labor, as part of a profession or job.
The person is participating in religious rites.
Basic status as defined in section 4.1.4 of RFC 3863
This value means that the associated contact element, if any, is ready to accept communication.
This value means that the associated contact element, if any, is unable to accept communication.
Enum describing RTP AVPF activation modes.
Use default value defined at upper level
AVPF is disabled
AVPF is enabled
Enum describing the status of a LinphoneAccountCreator operation.
Enum describing Ip family.
Enum describing type of audio route.
Enum describing the authentication methods
Enum representing the direction of a call.
outgoing calls
incoming calls
LinphoneCallState enum represents the different state a call can reach into. The application is notified of state changes through the
[LinphoneCoreVTable::call_state_changed]
callback.
Initial call state
This is a new incoming call
An outgoing call is started
An outgoing call is in progress
An outgoing call is ringing at remote end
An outgoing call is proposed early media
Connected, the call is answered
The media streams are established and running
The call is pausing at the initiative of local end
The call is paused, remote end has accepted the pause
The call is being resumed by local end
The call is being transfered to another party, resulting in a new outgoing call to follow immediately
The call encountered an error
The call ended normally
The call is paused by remote end
The call's parameters change is requested by remote end, used for example when video is added by remote
We are proposing early media to an incoming call
A call update has been initiated by us
The call object is no more retained by the core
Enum representing the status of a call
The call was sucessful
The call was aborted
The call was missed (unanswered)
The call was declined, either locally or by remote end
LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
Initial state
Delivery in progress
Message successfully delivered and acknowledged by server
Message was not delivered
Message was received(and acknowledged) but cannot get file from server
File transfer has been completed successfully.
Message successfully delivered and acknowledged to destination
Message displayed to the remote user
LinphoneGlobalState describes the global state of the LinphoneCore object. It is notified via the
[LinphoneCoreVTable::global_state_changed]
LinphoneCoreLogCollectionUploadState is used to notify if log collection upload have been succesfully delivered or not.
Delivery in progress
Log collection upload successfully delivered and acknowledged by remote end point
Log collection upload was not delivered
Policy to use to pass through firewalls.
Do not use any mechanism to pass through firewalls
Use the specified public adress
Use a STUN server to get the public address
Use the ICE protocol
Use the uPnP protocol
Enum describing the status of a LinphoneFriendList operation.
Enum describing the status of a CardDAV synchronization
LinphoneGlobalState describes the global state of the LinphoneCore object. It is notified via the
[LinphoneCoreVTable::global_state_changed]
Enum describing ICE states.
ICE has not been activated for this call or stream
ICE processing has failed
ICE process is in progress
ICE has established a direct connection to the remote host
ICE has established a connection to the remote host through one or several NATs
ICE has established a connection through a relay
Lime is not used at all
Lime is always used
Lime is used only if we already shared a secret with remote
Indicates for a given media the stream direction
No active media not supported yet
Send only mode
recv only mode
Enum describing type of media encryption types.
No media encryption is used
Use SRTP media encryption
Use ZRTP media encryption
Use DTLS media encryption
Enum describing remote friend status
Offline
Online
Busy
Be right back
Away
On the phone
Out to lunch
Do not disturb
Moved in this sate, call can be redirected if an alternate contact address has been set using function
[linphone_core_set_presence_info()]
Using another messaging service
Pending
Vacation
Defines privacy policy to apply as described by rfc3323
Privacy services must not perform any privacy function
Request that privacy services provide a user-level privacy function. With this mode, "from" header is hidden, usually replaced by From: "Anonymous" <sip:
anonymous@anonymous.invalid
>
Request that privacy services modify headers that cannot be set arbitrarily by the user (Contact/Via).
Request that privacy services provide privacy for session media
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. Note that a user requesting multiple types of privacy MUST include all of the requested privacy types in its Privacy header field value
Privacy service must perform the specified services or fail the request
Special keyword to use privacy as defined either globally or by proxy using
[linphone_proxy_config_set_privacy()]
Enum for publish states.
Initial state, do not use
An outgoing publish was created and submitted
Publish is accepted.
Publish encoutered an error,
[linphone_event_get_reason()]
gives reason code
Publish is about to expire, only sent if [sip]->refresh_generic_publish property is set to 0.
Event has been un published
Enum describing various failure reasons or contextual information for some events.
linphone_call_get_reason()
linphone_proxy_config_get_error()
linphone_error_info_get_reason()
No response received from remote
Authentication failed due to bad credentials or resource forbidden
The call has been declined
Destination of the call was not found
The call was not answered in time (request timeout)
Phone line was busy
Unsupported content
Transport error: connection failures, disconnections etc...
Do not disturb reason
Operation is unauthorized because missing credential
Operation is rejected due to incompatible or unsupported media parameters
Operation could not be executed by server or remote client because it didn't have any context for it
Resource moved permanently
Resource no longer exists
Temporarily unavailable
Address incomplete
Not implemented
Bad gateway
Server timeout
Unknown reason
LinphoneRegistrationState describes proxy registration states.
Initial state for registrations
Registration is in progress
Registration is successful
Unregistration succeeded
Registration failed
Enum describing the stream types.
Enum controlling behavior for incoming subscription request.
Use by
[linphone_friend_set_inc_subscribe_policy()]
Does not automatically accept an incoming subscription request. This policy implies that a decision has to be taken for each incoming subscription request notified by callback
[LinphoneCoreVTable.new_subscription_requested]
Rejects incoming subscription request.
Automatically accepts a subscription request.
Enum for subscription direction (incoming or outgoing).
Incoming subscription.
Outgoing subscription.
Invalid subscription direction.
Enum for subscription states. LinphoneSubscriptionTerminated and LinphoneSubscriptionError are final states.
Initial state, should not be used.
An outgoing subcription was sent
An incoming subcription is received
Subscription is pending, waiting for user approval
Subscription is accepted.
Subscription is terminated normally
Subscription was terminated by an error, indicated by
[linphone_event_get_reason()]
.
Subscription is about to expire, only sent if [sip]->refresh_generic_subscribe property is set to 0.
Enum describing transport type for LinphoneAddress.
Enum describing the tunnel modes.
The tunnel is disabled.
The tunnel is enabled.
The tunnel is enabled automatically if it is required.
Enum describing uPnP states.
uPnP is not activate
uPnP process is in progress
Internal use: Only used by port binding
Internal use: Only used by port binding
uPnP is not available
uPnP is enabled
uPnP processing has failed
IGD router is blacklisted
Enum describing the types of argument for LinphoneXmlRpcRequest.
Enum describing the status of a LinphoneXmlRpcRequest.
The new LinphoneAccountCreator object
The LinphoneCore used for the XML-RPC communication
The URL to the XML-RPC server. Must be NON NULL.
Create a LinphoneAccountCreator.
The new LinphoneAccountCreator object
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreator object
Send an XML-RPC request to activate a Linphone account.
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreatorOK if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreator object
Send an XML-RPC request to activate the link of a phone number with a Linphone account.
LinphoneAccountCreatorOK if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
A LinphoneProxyConfig object if successful, NULL otherwise
LinphoneAccountCreator object
Configure an account (create a proxy config and authentication info for it).
A LinphoneProxyConfig object if successful, NULL otherwise
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreator object
Send an XML-RPC request to create a Linphone account.
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreator object
Send an XML-RPC request to test the validation of a Linphone account.
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
if this account is linked with a phone number
LinphoneAccountCreator object
Send an XML-RPC request to ask if an account is linked with a phone number
if this account is linked with a phone number
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreator object
Send an XML-RPC request to test the existence of a Linphone account.
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreator object
Send an XML-RPC request to test the existence a phone number with a Linphone account.
LinphoneAccountCreatorOk if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreatorOK if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
LinphoneAccountCreator object
Send an XML-RPC request to link a phone number with a Linphone account.
LinphoneAccountCreatorOK if the request has been sent, LinphoneAccountCreatorReqFailed otherwise
The same LinphoneAccountCreator object.
LinphoneAccountCreator object.
Acquire a reference to the LinphoneAccountCreator.
The same LinphoneAccountCreator object.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
The phone number to set
Country code to associate phone number with
Set the phone number normalized.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object.
Release reference to the LinphoneAccountCreator.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
const char * : new password for the account creator
Update the password.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
The activation code to set
Set the activation code.
The LinphoneAccountCreatorCbs object associated with the LinphoneAccountCreator.
LinphoneAccountCreator object
Get the LinphoneAccountCreatorCbs object associated with a LinphoneAccountCreator.
The LinphoneAccountCreatorCbs object associated with the LinphoneAccountCreator.
The display name of the LinphoneAccountCreator
LinphoneAccountCreator object
Get the email.
The display name of the LinphoneAccountCreator
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
The display name to set
Set the email.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
The domain of the LinphoneAccountCreator
LinphoneAccountCreator object
Get the domain.
The domain of the LinphoneAccountCreator
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
The domain to set
Set the domain.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
The email of the LinphoneAccountCreator
LinphoneAccountCreator object
Get the email.
The email of the LinphoneAccountCreator
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
The email to set
Set the email.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
The ha1 of the LinphoneAccountCreator
LinphoneAccountCreator object
Get the ha1.
The ha1 of the LinphoneAccountCreator
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
The ha1 to set
Set the ha1.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
The language to use
Set the language to use in email or SMS if supported.
The password of the LinphoneAccountCreator
LinphoneAccountCreator object
Get the password.
The password of the LinphoneAccountCreator
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
The password to set
Set the password.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
The phone number of the LinphoneAccountCreator
LinphoneAccountCreator object
Get the RFC 3966 normalized phone number.
The phone number of the LinphoneAccountCreator
The route of the LinphoneAccountCreator
LinphoneAccountCreator object
Get the route.
The route of the LinphoneAccountCreator
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
The route to set
Set the route.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
The transport of the LinphoneAccountCreator
LinphoneAccountCreator object
Get the transport.
The transport of the LinphoneAccountCreator
LinphoneAccountCreatorOk if everything is OK, or a specific error if given transport is not supported by linphone core.
LinphoneAccountCreator object
The transport to set
Set the transport.
LinphoneAccountCreatorOk if everything is OK, or a specific error if given transport is not supported by linphone core.
The user pointer associated with the LinphoneAccountCreator.
LinphoneAccountCreator object.
Retrieve the user pointer associated with the LinphoneAccountCreator.
The user pointer associated with the LinphoneAccountCreator.
LinphoneAccountCreator object.
The user pointer to associate with the LinphoneAccountCreator.
Assign a user pointer to the LinphoneAccountCreator.
The username of the LinphoneAccountCreator
LinphoneAccountCreator object
Get the username.
The username of the LinphoneAccountCreator
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
LinphoneAccountCreator object
The username to set
Set the username.
LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
The LinphoneAccountCreator object used to create an account on a server via XML-RPC.
LinphoneAccountCreator object
The status of the LinphoneAccountCreator test existence operation that has just finished
Callback to notify a status change of the account creator.
The same LinphoneAccountCreatorCbs object.
LinphoneAccountCreatorCbs object.
Acquire a reference to a LinphoneAccountCreatorCbs object.
The same LinphoneAccountCreatorCbs object.
LinphoneAccountCreatorCbs object.
Release a reference to a LinphoneAccountCreatorCbs object.
The current activate account callback.
LinphoneAccountCreatorCbs object.
Get the activate account callback.
The current activate account callback.
LinphoneAccountCreatorCbs object.
The activate account callback to be used.
Set the activate account callback.
The current activate phone number link callback.
LinphoneAccountCreatorCbs object.
Get the activate phone number link callback.
The current activate phone number link callback.
LinphoneAccountCreatorCbs object.
The activate phone number link callback to be used.
Set the activate phone number link callback.
The current create account callback.
LinphoneAccountCreatorCbs object.
Get the create account callback.
The current create account callback.
LinphoneAccountCreatorCbs object.
The create account callback to be used.
Set the create account callback.
The current validation tested callback.
LinphoneAccountCreatorCbs object.
Get the validation tested callback.
The current validation tested callback.
LinphoneAccountCreatorCbs object.
The validation tested callback to be used.
Set the validation tested callback.
The current linked tested callback.
LinphoneAccountCreatorCbs object.
Get the current linked tested callback.
The current linked tested callback.
LinphoneAccountCreatorCbs object.
The existence tested callback to be used.
Set the linked tested callback
The current existence tested callback.
LinphoneAccountCreatorCbs object.
Get the existence tested callback.
The current existence tested callback.
LinphoneAccountCreatorCbs object.
The existence tested callback to be used.
Set the existence tested callback.
The current is phone number used callback
LinphoneAccountCreatorCbs object.
Get the is phone number used callback.
The current is phone number used callback
LinphoneAccountCreatorCbs object.
is phone number to be used.
Set the is phone number used callback.
The current link phone number with account callback.
LinphoneAccountCreatorCbs object.
Get the link phone number with account callback.
The current link phone number with account callback.
LinphoneAccountCreatorCbs object.
The link phone number with account callback to be used.
Set the link phone number with account callback.
The user pointer associated with the LinphoneAccountCreatorCbs object.
LinphoneAccountCreatorCbs object.
Retrieve the user pointer associated with a LinphoneAccountCreatorCbs object.
The user pointer associated with the LinphoneAccountCreatorCbs object.
LinphoneAccountCreatorCbs object.
The update hash callback to be used.
Assign a user pointer to a LinphoneAccountCreatorCbs object.
The user pointer associated with the LinphoneAccountCreatorCbs object.
LinphoneAccountCreatorCbs object.
Retrieve the user pointer associated with a LinphoneAccountCreatorCbs object.
The user pointer associated with the LinphoneAccountCreatorCbs object.
LinphoneAccountCreatorCbs object.
The user pointer to associate with the LinphoneAccountCreatorCbs object.
Assign a user pointer to a LinphoneAccountCreatorCbs object.
An object to handle the callbacks for handling the LinphoneAccountCreator operations.
Constructs a LinphoneAddress object by parsing the user supplied address, given as a string.
Returns the address as a string. The returned char * must be freed by the application. Use ms_free().
Returns the SIP uri only as a string, that is display name is removed. The returned char * must be freed by the application. Use ms_free().
Removes address's tags and uri headers so that it is displayable to the user.
Clones a LinphoneAddress object.
Destroys a LinphoneAddress object (actually calls
[linphone_address_unref()]
).
Boolean value telling if the LinphoneAddress objects are equal.
LinphoneAddress object
LinphoneAddress object
Compare two LinphoneAddress taking the tags and headers into account.
Boolean value telling if the LinphoneAddress objects are equal.
linphone_address_weak_equal()
Increment reference count of LinphoneAddress object.
the address
the header name
the header value
Set a header into the address. Headers appear in the URI with '?', such as <sip:
test@linphone.org
?SomeHeader=SomeValue>.
Decrement reference count of LinphoneAddress object. When dropped to zero, memory is freed.
Boolean value telling if the LinphoneAddress objects are equal.
LinphoneAddress object
LinphoneAddress object
Compare two LinphoneAddress ignoring tags and headers, basically just domain, username, and port.
Boolean value telling if the LinphoneAddress objects are equal.
linphone_address_equal()
Returns the display name.
Sets the display name.
Returns the domain name.
Sets the domain.
Get the value of the method parameter
Set the value of the method parameter
the password, if any, NULL otherwise.
the address
Get the password encoded in the address. It is used for basic authentication (not recommended).
the password, if any, NULL otherwise.
the LinphoneAddress
the password to set.
Set the password encoded in the address. It is used for basic authentication (not recommended).
Get port number as an integer value, 0 if not present.
Sets the port number.
Returns the address scheme, normally "sip".
Returns true if address refers to a secure location (sips)
A
[LinphoneAddress]
object
TRUE if address is requested to be secure.
Make the address refer to a secure location (sips scheme)
returns true if address is a routable sip address
Get the transport.
Set a transport.
Returns the username.
Sets the username.
Object that represents a SIP address.
The LinphoneAddress is an opaque object to represents SIP addresses, ie the content of SIP's 'from' and 'to' headers. 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
>'. The LinphoneAddress has methods to extract and manipulate all parts of the address. When some part of the address (for example the username) is empty, the accessor methods return NULL.
A
[LinphoneAuthInfo]
object.
[linphone_auth_info_destroy()]
must be used to destroy it when no longer needed. The LinphoneCore makes a copy of LinphoneAuthInfo passed through
[linphone_core_add_auth_info()]
.
The username that needs to be authenticated
The userid used for authenticating (use NULL if you don't know what it is)
The password in clear text
The ha1-encrypted password if password is not given in clear text.
The authentication domain (which can be larger than the sip domain. Unfortunately many SIP servers don't use this parameter.
The SIP domain for which this authentication information is valid, if it has to be restricted for a single SIP domain.
Creates a
[LinphoneAuthInfo]
object with supplied information. The object can be created empty, that is with all arguments set to NULL. Username, userid, password, realm and domain can be set later using specific methods. At the end, username and passwd (or ha1) are required.
A
[LinphoneAuthInfo]
object.
[linphone_auth_info_destroy()]
must be used to destroy it when no longer needed. The LinphoneCore makes a copy of LinphoneAuthInfo passed through
[linphone_core_add_auth_info()]
.
The newly created
[LinphoneAuthInfo]
object.
The
[LinphoneAuthInfo]
object to be cloned
Instantiates a new auth info with values from source.
The newly created
[LinphoneAuthInfo]
object.
Destroys a LinphoneAuthInfo object.
you don't need those function
Take ownership
Release ownership
The domain.
The
[LinphoneAuthInfo]
object
Gets the domain.
The domain.
The
[LinphoneAuthInfo]
object
The domain. This should not be necessary because realm is supposed to be unique and sufficient. However, many SIP servers don't set realm correctly, then domain has to be used to distinguish between several SIP account bearing the same username.
Sets the domain for which this authentication is valid.
The ha1.
The
[LinphoneAuthInfo]
object
Gets the ha1.
The ha1.
The
[LinphoneAuthInfo]
object
The ha1.
Sets the ha1.
The password.
The
[LinphoneAuthInfo]
object
Gets the password.
The password.
The
[LinphoneAuthInfo]
object
The password.
Sets the password.
The realm.
The
[LinphoneAuthInfo]
object
Gets the realm.
The realm.
The
[LinphoneAuthInfo]
object
The realm.
Sets the realm.
The TLS certificate.
The
[LinphoneAuthInfo]
object
Gets the TLS certificate.
The TLS certificate.
The
[LinphoneAuthInfo]
object
The TLS certificate.
Sets the TLS certificate.
The TLS certificate path.
The
[LinphoneAuthInfo]
object
Gets the TLS certificate path.
The TLS certificate path.
The
[LinphoneAuthInfo]
object
The TLS certificate path.
Sets the TLS certificate path.
The TLS key.
The
[LinphoneAuthInfo]
object
Gets the TLS key.
The TLS key.
The
[LinphoneAuthInfo]
object
The TLS key.
Sets the TLS key.
The TLS key path.
The
[LinphoneAuthInfo]
object
Gets the TLS key path.
The TLS key path.
The
[LinphoneAuthInfo]
object
Sets the TLS key path.
The userid.
The
[LinphoneAuthInfo]
object
Gets the userid.
The userid.
The
[LinphoneAuthInfo]
object
The userid.
Sets the userid.
The username.
The
[LinphoneAuthInfo]
object
Gets the username.
The username.
The
[LinphoneAuthInfo]
object
The username.
Sets the username.
Object holding authentication information.
The object's fields should not be accessed directly. Prefer using the accessor methods.
In most case, authentication information consists of a username and password. Sometimes, a userid is required by proxy, and realm can be useful to discriminate different SIP domains.
Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in order to become known and used automatically when needed. Use
[linphone_core_add_auth_info()]
for that purpose.
The LinphoneCore object can take the initiative to request authentication information when needed to the application through the auth_info_requested callback of the LinphoneCoreVTable structure.
The application can respond to this information request later using
[linphone_core_add_auth_info()]
. This will unblock all pending authentication transactions and retry them with authentication headers.
A new LinphoneBuffer object.
Create a new empty LinphoneBuffer object.
A new LinphoneBuffer object.
A new LinphoneBuffer object.
The initial data to store in the LinphoneBuffer.
The size of the initial data to stroe in the LinphoneBuffer.
Create a new LinphoneBuffer object from existing data.
A new LinphoneBuffer object.
A new LinphoneBuffer object.
The initial string content of the LinphoneBuffer.
Create a new LinphoneBuffer object from a string.
A new LinphoneBuffer object.
The same LinphoneBuffer object.
LinphoneBuffer object.
Acquire a reference to the buffer.
The same LinphoneBuffer object.
LinphoneBuffer object.
The content of the data buffer.
The size of the content of the data buffer.
Set the content of the data buffer.
LinphoneBuffer object.
Release reference to the buffer.
The content of the data buffer.
LinphoneBuffer object.
Get the content of the data buffer.
The content of the data buffer.
A boolean value telling whether the LinphoneBuffer is empty or not.
LinphoneBuffer object
Tell whether the LinphoneBuffer is empty.
A boolean value telling whether the LinphoneBuffer is empty or not.
The size of the content of the data buffer.
LinphoneBuffer object.
Get the size of the content of the data buffer.
The size of the content of the data buffer.
LinphoneBuffer object
The size of the content of the data buffer.
Set the size of the content of the data buffer.
The string content of the data buffer.
LinphoneBuffer object
Get the string content of the data buffer.
The string content of the data buffer.
LinphoneBuffer object.
The string content of the data buffer.
Set the string content of the data buffer.
The user pointer associated with the buffer.
LinphoneBuffer object.
Retrieve the user pointer associated with the buffer.
The user pointer associated with the buffer.
LinphoneBuffer object.
The user pointer to associate with the buffer.
Assign a user pointer to the buffer.
The LinphoneContent object representing a data buffer.
A boolean value telling whether the call has been asked to autoanswer
LinphoneCall object
Tell whether a call has been asked to autoanswer
A boolean value telling whether the call has been asked to autoanswer
The LinphoneCall object
Stop current DTMF sequence sending.
Please note that some DTMF could be already sent, depending on when this function call is delayed from
[linphone_call_send_dtmfs]
. This function will be automatically called if call state change to anything but LinphoneCallStreamsRunning.
a pointer to the meta rtcp transport if it exists, NULL otherwise
Returns the meta rtcp transport for the given stream index.
a pointer to the meta rtcp transport if it exists, NULL otherwise
a pointer to the meta rtp transport if it exists, NULL otherwise
Returns the meta rtp transport for the given stream index.
a pointer to the meta rtp transport if it exists, NULL otherwise
the type (MSAudio, MSVideo, MSText) of the stream of given index.
Returns the type of stream for the given stream index.
the type (MSAudio, MSVideo, MSText) of the stream of given index.
Returns true if this calls has received a transfer that has not been executed yet. Pending transfers are executed when this call is being paused or closed, locally or by remote endpoint. If the call is already paused while receiving the transfer request, the transfer immediately occurs.
TRUE if media is busy in establishing the connection, FALSE otherwise.
the call
Indicates whether an operation is in progress at the media side. It can be a bad idea to initiate signaling operations (adding video, pausing the call, removing video, changing video parameters) while the media is busy in establishing the connection (typically ICE connectivity checks). It can result in failures generating loss of time in future operations in the call. Applications are invited to check this function after each call state change to decide whether certain operations are permitted or not.
TRUE if media is busy in establishing the connection, FALSE otherwise.
The same call.
The call.
Acquire a reference to the call. An application that wishes to retain a pointer to call object must use this function to unsure the pointer remains valid. Once the application no more needs this pointer, it must call
[linphone_call_unref()]
.
The same call.
0 if successful, -1 on error.
The LinphoneCall object
The dtmf name specified as a char, such as '0', '#' etc...
Send the specified dtmf.
The dtmf is automatically played to the user.
0 if successful, -1 on error.
-2 if there is already a DTMF sequence, -1 if call is not ready, 0 otherwise.
The LinphoneCall object
A dtmf sequence such as '123#123123'
Send a list of dtmf.
The dtmfs are automatically sent to remote, separated by some needed customizable delay. Sending is canceled if the call state changes to something not LinphoneCallStreamsRunning.
-2 if there is already a DTMF sequence, -1 if call is not ready, 0 otherwise.
Request remote side to send us a Video Fast Update.
Start call recording. The output file where audio is recorded must be previously specified with
[linphone_call_params_set_record_file()]
.
Stop call recording.
0 if successfull, -1 otherwise (typically if jpeg format is not supported).
a LinphoneCall
a path where to write the jpeg content.
Take a photo of currently captured video and write it into a jpeg file. Note that the snapshot is asynchronous, an application shall not assume that the file is created when the function returns.
0 if successfull, -1 otherwise (typically if jpeg format is not supported).
0 if successfull, -1 otherwise (typically if jpeg format is not supported).
a LinphoneCall
a path where to write the jpeg content.
Take a photo of currently received video and write it into a jpeg file. Note that the snapshot is asynchronous, an application shall not assume that the file is created when the function returns.
0 if successfull, -1 otherwise (typically if jpeg format is not supported).
The call.
Release reference to the call.
the call.
a floating point number describing the zoom factor. A value 1.0 corresponds to no zoom applied.
a floating point number pointing the horizontal center of the zoom to be applied. This value should be between 0.0 and 1.0.
a floating point number pointing the vertical center of the zoom to be applied. This value should be between 0.0 and 1.0.
Perform a zoom of the video displayed during a call.
the wanted audio route (earpiece, speaker, ...)
Change the playback output device (currently only used for blackberry)
TRUE if authentication token is verifed, false otherwise.
the LinphoneCall
Returns whether ZRTP authentication token is verified. If not, it must be verified by users as described in ZRTP procedure. Once done, the application must inform of the results with
[linphone_call_set_authentication_token_verified()]
.
TRUE if authentication token is verifed, false otherwise.
the LinphoneCall
whether the ZRTP SAS is verified.
Set the result of ZRTP short code verification by user. If remote party also does the same, it will update the ZRTP cache so that user's verification will not be required for the two users.
Returns call quality averaged over all the duration of the call.
See
[linphone_call_get_current_quality()]
for more details about quality measurement.
The LinphoneCallLog associated with the specified LinphoneCall
LinphoneCall object
Gets the call log associated to this call.
The LinphoneCallLog associated with the specified LinphoneCall
Returns TRUE if camera pictures are allowed to be sent to the remote party.
Indicate whether camera input should be sent to remote end.
[LinphoneChatRoom]
where messaging can take place.
[LinphoneCall]
object
Create a new chat room for messaging from a call if not already existing, else return existing one. No reference is given to the caller: the chat room will be deleted when the call is ended.
[LinphoneChatRoom]
where messaging can take place.
A pointer on
[LinphoneConference]
or NULL if the call is not part of any conference.
[LinphoneCall]
Return the associated conference object
A pointer on
[LinphoneConference]
or NULL if the call is not part of any conference.
The LinphoneCore object that has created the specified call.
LinphoneCall object
Get the core that has created the specified call.
The LinphoneCore object that has created the specified call.
Returns current parameters associated to the call.
The function returns -1 if no quality measurement is available, for example if no active audio stream exist. Otherwise it returns the quality rating.
Obtain real-time quality rating of the call
Based on local RTP statistics and RTCP feedback, a quality rating is computed and updated during all the duration of the call. This function returns its value at the time of the function call. It is expected that the rating is updated at least every 5 seconds or so. The rating is a floating point number comprised between 0 and 5.
4-5 = good quality
3-4 = average quality
2-3 = poor quality
1-2 = very poor quality
0-1 = can't be worse, mostly unusable
The function returns -1 if no quality measurement is available, for example if no active audio stream exist. Otherwise it returns the quality rating.
Returns direction of the call (incoming or outgoing).
Returns the diversion address associated to this call
Returns call's duration in seconds.
Returns TRUE if echo cancellation is enabled.
Enables or disable echo cancellation for this call
Returns TRUE if echo limiter is enabled.
Enables or disable echo limiter for this call
Returns full details about call errors or termination reasons.
TRUE if part of a conference.
[LinphoneCall]
Return TRUE if this call is currently part of a conference
TRUE if part of a conference.
Return TRUE if this call is currently part of a conference
double Percenatge of the max supported volume gain. Valid values are in [ 0.0 : 1.0 ]. In case of failure, a negative value is returned
The call.
Get microphone volume gain. If the sound backend supports it, the returned gain is equal to the gain set with the system mixer.
double Percenatge of the max supported volume gain. Valid values are in [ 0.0 : 1.0 ]. In case of failure, a negative value is returned
The call.
Percentage of the max supported gain. Valid values are in [ 0.0 : 1.0 ].
Set microphone volume gain. If the sound backend supports it, the new gain will synchronized with the system mixer.
Get the native window handle of the video window, casted as an unsigned long.
Set the native video window id where the video is to be displayed. For MacOS, Linux, Windows: if not set or 0 a window will be automatically created, unless the special id -1 is given.
float Volume level in percentage.
The call.
Get the mesured playback volume level (received from remote) in dbm0.
float Volume level in percentage.
Returns the reason for a call termination (either error or normal termination)
float Volume level in percentage.
The call.
Get the mesured record volume level (sent to remote) in dbm0.
float Volume level in percentage.
The refer-to uri of the call (if it was transfered)
LinphoneCall object
Gets the refer-to uri (if the call was transfered).
The refer-to uri of the call (if it was transfered)
Returns the remote address associated to this call
Returns the remote address associated to this call as a string. The result string must be freed by user using ms_free().
Returns the far end's sip contact as a string, if available.
Returns call parameters proposed by remote.
This is useful when receiving an incoming call, to know whether the remote party supports video, encryption or whatever.
Returns the far end's user agent description string, if available.
Returns the call object this call is replacing, if any. Call replacement can occur during call transfers. By default, the core automatically terminates the replaced call and accept the new one. This function allows the application to know whether a new incoming call is a one that replaces another one.
Percenatge of the max supported volume gain. Valid values are in [ 0.0 : 1.0 ]. In case of failure, a negative value is returned
The call.
Get speaker volume gain. If the sound backend supports it, the returned gain is equal to the gain set with the system mixer.
Percenatge of the max supported volume gain. Valid values are in [ 0.0 : 1.0 ]. In case of failure, a negative value is returned
The call.
Percentage of the max supported gain. Valid values are in [ 0.0 : 1.0 ].
Set speaker volume gain. If the sound backend supports it, the new gain will synchronized with the system mixer.
Retrieves the call's current state.
2
Returns the number of stream for the given call. Currently there is only two (Audio, Video), but later there will be more.
2
Returns the current transfer state, if a transfer has been initiated from this call.
linphone_core_transfer_call() , linphone_core_transfer_call_to_another()
When this call has received a transfer request, returns the new call that was automatically created as a result of the transfer.
The transferer call if the specified call was started automatically as a result of an incoming transfer request, NULL otherwise
LinphoneCall object
Gets the transferer if this call was started automatically as a result of an incoming transfer request. The call in which the transfer request was received is returned in this case.
The transferer call if the specified call was started automatically as a result of an incoming transfer request, NULL otherwise
The user pointer associated with the call.
The call.
Retrieve the user pointer associated with the call.
The user pointer associated with the call.
The call.
The user pointer to associate with the call.
Assign a user pointer to the call.
The LinphoneCall object represents a call issued or received by the LinphoneCore
LinphoneCallLog object
Destroy a LinphoneCallLog.
The same LinphoneCallLog object
LinphoneCallLog object
Acquire a reference to the call log.
The same LinphoneCallLog object
A human readable string describing the call.
LinphoneCallLog object
Get a human readable string describing the call.
: the returned string must be freed by the application (use ms_free()).
A human readable string describing the call.
LinphoneCallLog object
Release a reference to the call log.
TRUE if the call was a call to a conference server
[LinphoneCallLog]
object
Tells whether that call was a call to a conference server
TRUE if the call was a call to a conference server
The call ID used by the call as a string.
LinphoneCallLog object
Get the call ID used by the call.
The call ID used by the call as a string.
The direction of the call.
LinphoneCallLog object
Get the direction of the call.
The direction of the call.
The duration of the call in seconds.
LinphoneCallLog object
Get the duration of the call since connected.
The duration of the call in seconds.
The origin address (ie from) of the call.
LinphoneCallLog object
Get the origin address (ie from) of the call.
The origin address (ie from) of the call.
The RTP statistics that have been computed locally for the call.
LinphoneCallLog object
Get the RTP statistics computed locally regarding the call.
The RTP statistics that have been computed locally for the call.
The overall quality indication of the call.
LinphoneCallLog object
Get the overall quality indication of the call.
The overall quality indication of the call.
The reference key string that has been associated to the call log, or NULL if none has been associated.
LinphoneCallLog object
Get the persistent reference key associated to the call log.
The reference key can be for example an id to an external database. It is stored in the config file, thus can survive to process exits/restarts.
The reference key string that has been associated to the call log, or NULL if none has been associated.
LinphoneCallLog object
The reference key string to associate to the call log.
Associate a persistent reference key to the call log.
The reference key can be for example an id to an external database. It is stored in the config file, thus can survive to process exits/restarts.
The remote address of the call.
LinphoneCallLog object
Get the remote address (that is from or to depending on call direction).
The remote address of the call.
The RTP statistics that have been computed by the remote end for the call.
LinphoneCallLog object
Get the RTP statistics computed by the remote end and sent back via RTCP.
Not implemented yet.
The RTP statistics that have been computed by the remote end for the call.
The date of the beginning of the call.
LinphoneCallLog object
Get the start date of the call.
The date of the beginning of the call.
The status of the call.
LinphoneCallLog object
Get the status of the call.
The status of the call.
The destination address (ie to) of the call.
LinphoneCallLog object
Get the destination address (ie to) of the call.
The destination address (ie to) of the call.
The user data associated with the call log.
LinphoneCallLog object
Get the user data associated with the call log.
The user data associated with the call log.
LinphoneCallLog object
The user data to associate with the call log.
Assign a user data to the call log.
A boolean value telling whether video was enabled at the end of the call.
LinphoneCallLog object
Tell whether video was enabled at the end of the call or not.
A boolean value telling whether video was enabled at the end of the call.
Structure representing a call log.
The
[LinphoneCallParams]
to add a custom SIP header to.
The name of the header to add.
The content of the header to add.
Add a custom SIP header in the INVITE for a call.
The
[LinphoneCallParams]
to add a custom SDP attribute to.
The name of the attribute to add.
The content value of the attribute to add.
Add a custom attribute related to all the streams in the SDP exchanged within SIP messages during a call.
The
[LinphoneCallParams]
to add a custom SDP attribute to.
The type of the stream to add a custom SDP attribute to.
The name of the attribute to add.
The content value of the attribute to add.
Add a custom attribute related to a specific stream in the SDP exchanged within SIP messages during a call.
The
[LinphoneCallParams]
to clear the custom SDP attributes from.
Clear the custom SDP attributes related to all the streams in the SDP exchanged within SIP messages during a call.
The
[LinphoneCallParams]
to clear the custom SDP attributes from.
The type of the stream to clear the custom SDP attributes from.
Clear the custom SDP attributes related to a specific stream in the SDP exchanged within SIP messages during a call.
A copy of the LinphoneCallParams object.
The LinphoneCallParams object to copy.
Copy an existing LinphoneCallParams object to a new LinphoneCallParams object.
A copy of the LinphoneCallParams object.
LinphoneCallParams object
Destroy a LinphoneCallParams object.
The content of the header or NULL if not found.
The
[LinphoneCallParams]
to get the custom SIP header from.
The name of the header to get.
Get a custom SIP header.
The content of the header or NULL if not found.
The content value of the attribute or NULL if not found.
The
[LinphoneCallParams]
to get the custom SDP attribute from.
The name of the attribute to get.
Get a custom SDP attribute that is related to all the streams.
The content value of the attribute or NULL if not found.
The content value of the attribute or NULL if not found.
The
[LinphoneCallParams]
to get the custom SDP attribute from.
The type of the stream to add a custom SDP attribute to.
The name of the attribute to get.
Get a custom SDP attribute that is related to a specific stream.
The content value of the attribute or NULL if not found.
The same LinphoneCallParams object
LinphoneCallParams object
Acquire a reference to the call params.
The same LinphoneCallParams object
LinphoneCallParams object
Release a reference to the call params.
LinphoneCallParams object
The audio bandwidth limit to set in kbit/s.
Refine bandwidth settings for this call by setting a bandwidth limit for audio streams. As a consequence, codecs whose bitrates are not compatible with this limit won't be used.
The audio stream direction associated with the call params.
LinphoneCallParams object
Get the audio stream direction.
The audio stream direction associated with the call params.
LinphoneCallParams object
The audio stream direction associated with this call params.
Set the audio stream direction.
A boolean value telling whether audio is enabled or not.
LinphoneCallParams object
Tell whether audio is enabled or not.
A boolean value telling whether audio is enabled or not.
LinphoneCallParams object
A boolean value telling whether to enable audio or not.
Enable audio stream.
true if subsequent calls will propose multicast ip set by
[linphone_core_set_audio_multicast_addr]
[LinphoneCallParams]
Use to get multicast state of audio stream.
true if subsequent calls will propose multicast ip set by
[linphone_core_set_audio_multicast_addr]
Use to enable multicast rtp for audio stream.
If enabled, outgoing calls put a multicast address from
[linphone_core_get_video_multicast_addr]
into audio cline. In case of outgoing call audio stream is sent to this multicast address.
For incoming calls behavior is unchanged.
params
[LinphoneCallParams]
yesno
if yes, subsequent calls will propose multicast ip set by
[linphone_core_set_audio_multicast_addr]
A boolean value telling whether sending of early media was enabled.
LinphoneCallParams object
Indicate whether sending of early media was enabled.
A boolean value telling whether sending of early media was enabled.
LinphoneCallParams object
A boolean value telling whether to enable early media sending or not.
Enable sending of real early media (during outgoing calls).
A boolean value telling whether the call is part of the locally managed conference.
LinphoneCallParams object
Tell whether the call is part of the locally managed conference.
If a conference server is used to manage conferences, that function does not return TRUE even if the conference is running.
If you want to test whether the conference is running, you should test whether
[linphone_core_get_conference()]
return a non-null pointer.
A boolean value telling whether the call is part of the locally managed conference.
A boolean value telling whether the low bandwidth mode has been configured/detected.
LinphoneCallParams object
Tell whether the call has been configured in low bandwidth mode or not. This mode can be automatically discovered thanks to a stun server when activate_edge_workarounds=1 in section [net] of configuration file. An application that would have reliable way to know network capacity may not use activate_edge_workarounds=1 but instead manually configure low bandwidth mode with
[linphone_call_params_enable_low_bandwidth()]
. When enabled, this param may transform a call request with video in audio only mode.
A boolean value telling whether the low bandwidth mode has been configured/detected.
LinphoneCallParams object
A boolean value telling whether to activate the low bandwidth mode or not.
Indicate low bandwith mode. Configuring a call to low bandwidth mode will result in the core to activate several settings for the call in order to ensure that bitrate usage is lowered to the minimum possible. Typically, ptime (packetization time) will be increased, audio codec's output bitrate will be targetted to 20kbit/s provided that it is achievable by the codec selected after SDP handshake. Video is automatically disabled.
The kind of media encryption selected for the call.
LinphoneCallParams object
Get the kind of media encryption selected for the call.
The kind of media encryption selected for the call.
LinphoneCallParams object
The media encryption to use for the call.
Set requested media encryption for a call.
The privacy mode used for the call.
LinphoneCallParams object
Get requested level of privacy for the call.
The privacy mode used for the call.
LinphoneCallParams object
The privacy mode to used for the call.
Set requested level of privacy for the call.
javascript
returns true if call rtt is activated.
[LinphoneCallParams]
Use to get real time text following rfc4103.
returns true if call rtt is activated.
[LinphoneCallParams]
if yes, subsequent outgoing calls will propose rtt
Use to enable real time text following rfc4103. If enabled, outgoing calls put a m=text line in SDP offer .
The actual received framerate in frames per seconds, 0 if not available.
LinphoneCallParams object
Get the framerate of the video that is received.
The actual received framerate in frames per seconds, 0 if not available.
The received video size or MS_VIDEO_SIZE_UNKNOWN if not available.
LinphoneCallParams object
Get the size of the video that is received.
The received video size or MS_VIDEO_SIZE_UNKNOWN if not available.
The path to the audio recording of the call.
LinphoneCallParams object
Get the path for the audio recording of the call.
The path to the audio recording of the call.
LinphoneCallParams object
A string containing the path and filename of the file where audio/video streams are to be written. The filename must have either .mkv or .wav extention. The video stream will be written only if a MKV file is given.
Enable recording of the call. This function must be used before the call parameters are assigned to the call. The call recording can be started and paused after the call is established with
[linphone_call_start_recording()]
and linphone_call_pause_recording().
The RTP profile.
[LinphoneCallParams]
object
Get the RTP profile being used.
The RTP profile.
The actual sent framerate in frames per seconds, 0 if not available.
LinphoneCallParams object
Get the framerate of the video that is sent.
The actual sent framerate in frames per seconds, 0 if not available.
The sent video size or MS_VIDEO_SIZE_UNKNOWN if not available.
LinphoneCalParams object
Gets the size of the video that is sent.
The sent video size or MS_VIDEO_SIZE_UNKNOWN if not available.
The session name of the media session.
LinphoneCallParams object
Get the session name of the media session (ie in SDP). Subject from the SIP message can be retrieved using
[linphone_call_params_get_custom_header()]
and is different.
The session name of the media session.
LinphoneCallParams object
The session name to be used.
Set the session name of the media session (ie in SDP). Subject from the SIP message (which is different) can be set using linphone_call_params_set_custom_header().
The LinphonePayloadType object corresponding to the audio codec being used in the call.
LinphoneCallParams object
Get the audio codec used in the call, described as a LinphonePayloadType object.
The LinphonePayloadType object corresponding to the audio codec being used in the call.
The LinphonePayloadType object corresponding to the text codec being used in the call.
LinphoneCallParams object
Get the text codec used in the call, described as a LinphonePayloadType structure.
The LinphonePayloadType object corresponding to the text codec being used in the call.
The LinphonePayloadType object corresponding to the video codec being used in the call.
LinphoneCallParams object
Get the video codec used in the call, described as a LinphonePayloadType structure.
The LinphonePayloadType object corresponding to the video codec being used in the call.
The user data associated with the call params.
LinphoneCallParams object
Get the user data associated with the call params.
The user data associated with the call params.
LinphoneCallParams object
The user data to associate with the call params.
Assign a user data to the call params.
The video stream direction associated with the call params.
LinphoneCallParams object
Get the video stream direction.
The video stream direction associated with the call params.
LinphoneCallParams object
The video stream direction associated with this call params.
Set the video stream direction.
A boolean value telling whether video is enabled or not.
LinphoneCallParams object
Tell whether video is enabled or not.
A boolean value telling whether video is enabled or not.
LinphoneCallParams object
A boolean value telling whether to enable video or not.
Enable video stream.
true if subsequent calls will propose multicast ip set by
[linphone_core_set_video_multicast_addr]
[LinphoneCallParams]
Use to get multicast state of video stream.
true if subsequent calls will propose multicast ip set by
[linphone_core_set_video_multicast_addr]
[LinphoneCallParams]
if yes, subsequent outgoing calls will propose multicast ip set by
[linphone_core_set_video_multicast_addr]
Use to enable multicast rtp for video stream. If enabled, outgoing calls put a multicast address from
[linphone_core_get_video_multicast_addr]
into video cline. In case of outgoing call video stream is sent to this multicast address.
For incoming calls behavior is unchanged.
The LinphoneCallParams is an object containing various call related parameters. It can be used to retrieve parameters from a currently running call or modify the call's characteristics dynamically.
The cumulative number of late packets
Gets the cumulative number of late packets
The cumulative number of late packets
The interarrival jitter at last received receiver report
Gets the remote reported interarrival jitter
The interarrival jitter at last received receiver report
The interarrival jitter at last emitted sender report
Gets the local interarrival jitter
The interarrival jitter at last emitted sender report
The bandwidth measurement of the received stream in kbit/s.
LinphoneCallStats object
Get the bandwidth measurement of the received stream, expressed in kbit/s, including IP/UDP/RTP headers.
The bandwidth measurement of the received stream in kbit/s.
The state of ICE processing.
LinphoneCallStats object
Get the state of ICE processing.
The state of ICE processing.
The receiver loss rate
Gets the remote reported loss rate since last report
The receiver loss rate
The sender loss rate
Get the local loss rate since last report
The sender loss rate
The bandwidth measurement of the sent stream in kbit/s.
LinphoneCallStats object
Get the bandwidth measurement of the sent stream, expressed in kbit/s, including IP/UDP/RTP headers.
The bandwidth measurement of the sent stream in kbit/s.
The state of uPnP processing.
LinphoneCallStats object
Get the state of uPnP processing.
The state of uPnP processing.
The LinphoneCallStats objects carries various statistic informations regarding quality of audio or video streams.
To receive these informations periodically and as soon as they are computed, the application is invited to place a
[LinphoneCoreCallStatsUpdatedCb]
callback in the LinphoneCoreVTable structure it passes for instanciating the LinphoneCore object (see
[linphone_core_new()]
).
At any time, the application can access last computed statistics using linphone_call_get_audio_stats() or linphone_call_get_video_stats().
[LinphoneChatMessage]
object
application user data
Call back used to notify message delivery status
Returns a
[LinphoneChatMessageState]
as a string.
the message
name of the header_name
header value
Add custom headers to the message.
[LinphoneChatMessage]
Cancel an ongoing file transfer attached to this message.(upload or download)
Duplicate a LinphoneChatMessage
Destroys a LinphoneChatMessage.
LinphoneChatMessage object.
Start the download of the file referenced in a LinphoneChatMessage from remote server.
the message
header name searched
Retrieve a custom header value given its name.
0 if succeed.
LinphoneChatMessage
T.140 char
Fulfill a chat message char by char. Message linked to a Real Time Text Call send char in realtime following RFC 4103/T.140 To commit a message, use
[linphone_chat_room_send_message]
0 if succeed.
the same chat message
the chat message
Acquire a reference to the chat message.
the same chat message
name of the header to remove
Removes a custom header from the message.
[LinphoneChatMessage]
LinphoneChatMessageStateChangeCb status callback invoked when file is downloaded or could not be downloaded
user data
Start the download of the file from remote server
the chat message.
Release reference to the chat message.
the application-specific data or NULL if none has been stored.
[LinphoneChatMessage]
Linphone message has an app-specific field that can store a text. The application might want to use it for keeping data over restarts, like thumbnail image path.
the application-specific data or NULL if none has been stored.
[LinphoneChatMessage]
the data to store into the message
Linphone message has an app-specific field that can store a text. The application might want to use it for keeping data over restarts, like thumbnail image path.
Invoking this function will attempt to update the message storage to reflect the changeif it is enabled.
The LinphoneChatMessageCbs object associated with the LinphoneChatMessage.
LinphoneChatMessage object
Get the LinphoneChatMessageCbs object associated with the LinphoneChatMessage.
The LinphoneChatMessageCbs object associated with the LinphoneChatMessage.
Returns the chatroom this message belongs to.
a LinphoneErrorInfo describing the details.
a LinphoneChatMessage
Get full details about delivery error of a chat message.
a LinphoneErrorInfo describing the details.
external body url or NULL if not present.
[LinphoneChatMessage]
Linphone message can carry external body as defined by rfc2017
external body url or NULL if not present.
a LinphoneChatMessage
ex: access-type=URL; URL="http://www.foo.com/file"
Linphone message can carry external body as defined by rfc2017
The path to the file to use for the file transfer.
LinphoneChatMessage object
Get the path to the file to read from or write to during the file transfer.
The path to the file to use for the file transfer.
LinphoneChatMessage object
The path to the file to use for the file transfer.
Set the path to the file to read from or write to during the file transfer.
a pointer to the LinphoneContent structure or NULL if not present.
[LinphoneChatMessage]
Get the file_transfer_information (used by call backs to recover informations during a rcs file transfer)
a pointer to the LinphoneContent structure or NULL if not present.
[LinphoneAddress]
[LinphoneChatMessage]
obj
Get origin of the message
[LinphoneAddress]
[LinphoneChatMessage]
obj
[LinphoneAddress]
origin of this message (copied)
Set origin of the message
[LinphoneAddress]
[LinphoneChatMessage]
obj
Returns the origin address of a message if it was a outgoing message, or the destination address if it was an incoming message.
[LinphoneAddress]
The message identifier.
LinphoneChatMessage object
Get the message identifier. It is used to identify a message so that it can be notified as delivered and/or displayed.
The message identifier.
the message
Returns TRUE if the message has been sent, returns FALSE if the message has been received.
the message
Returns TRUE if the message has been read, otherwise returns FALSE.
[LinphoneChatMessageState]
[LinphoneChatMessage]
obj
Get the state of the message
[LinphoneChatMessageState]
the id
the message
Returns the id used to identify this message in the storage database
the id
text or NULL if no text.
Get text part of this message
text or NULL if no text.
Get the time the message was sent.
[LinphoneAddress]
[LinphoneChatMessage]
obj
Get destination of the message
[LinphoneAddress]
[LinphoneChatMessage]
obj
[LinphoneAddress]
destination of this message (copied)
Set destination of the message
User pointer get function
User pointer set function
A chat room message to hold content to be sent.
Can be created by
[linphone_chat_room_create_message()]
.
[LinphoneChatMessage]
message from which the body is received.
[LinphoneContent]
incoming content information
The number of bytes sent/received since the beginning of the transfer.
The total number of bytes to be sent/received.
File transfer progress indication callback prototype.
[LinphoneChatMessage]
message from which the body is received.
[LinphoneContent]
incoming content information
[LinphoneBuffer]
holding the received data. Empty buffer means end of file.
File transfer receive callback prototype. This function is called by the core upon an incoming File transfer is started. This function may be call several time for the same file in case of large file.
A LinphoneBuffer object holding the data written by the application. An empty buffer means end of file.
[LinphoneChatMessage]
message from which the body is received.
[LinphoneContent]
outgoing content
the offset in the file from where to get the data to be sent
the number of bytes expected by the framework
File transfer send callback prototype. This function is called by the core when an outgoing file transfer is started. This function is called until size is set to 0.
A LinphoneBuffer object holding the data written by the application. An empty buffer means end of file.
[LinphoneChatMessage]
object
Call back used to notify message delivery status
The same LinphoneChatMessageCbs object.
LinphoneChatMessageCbs object.
Acquire a reference to the LinphoneChatMessageCbs object.
The same LinphoneChatMessageCbs object.
LinphoneChatMessageCbs object.
Release reference to the LinphoneChatMessageCbs object.
The current file transfer progress indication callback.
LinphoneChatMessageCbs object.
Get the file transfer progress indication callback.
The current file transfer progress indication callback.
LinphoneChatMessageCbs object.
The file transfer progress indication callback to be used.
Set the file transfer progress indication callback.
The current file transfer receive callback.
LinphoneChatMessageCbs object.
Get the file transfer receive callback.
The current file transfer receive callback.
LinphoneChatMessageCbs object.
The file transfer receive callback to be used.
Set the file transfer receive callback.
The current file transfer send callback.
LinphoneChatMessageCbs object.
Get the file transfer send callback.
The current file transfer send callback.
LinphoneChatMessageCbs object.
The file transfer send callback to be used.
Set the file transfer send callback.
The current message state changed callback.
LinphoneChatMessageCbs object.
Get the message state changed callback.
The current message state changed callback.
LinphoneChatMessageCbs object.
The message state changed callback to be used.
Set the message state changed callback.
The user pointer associated with the LinphoneChatMessageCbs object.
LinphoneChatMessageCbs object.
Retrieve the user pointer associated with the LinphoneChatMessageCbs object.
The user pointer associated with the LinphoneChatMessageCbs object.
LinphoneChatMessageCbs object.
The user pointer to associate with the LinphoneChatMessageCbs object.
Assign a user pointer to the LinphoneChatMessageCbs object.
An object to handle the callbacks for the handling a LinphoneChatMessage objects.
The
[LinphoneChatRoom]
object corresponding to the conversation for which a new message is being typed.
Notifies the destination of the chat message being composed that the user is typing a new message.
a new
[LinphoneChatMessage]
the chat room.
[LinphoneContent]
initial content.
[LinphoneCoreVTable.file_transfer_send]
is invoked later to notify file transfer progress and collect next chunk of the message if #LinphoneContent.data is NULL.
Create a message attached to a dedicated chat room with a particular content. Use
[linphone_chat_room_send_message]
to initiate the transfer
a new
[LinphoneChatMessage]
a new
[LinphoneChatMessage]
the chat room.
text message, NULL if absent.
Create a message attached to a dedicated chat room;
a new
[LinphoneChatMessage]
a new
[LinphoneChatMessage]
the chat room.
text message, NULL if absent.
the URL given in external body or NULL.
the LinphoneChatMessage.State of the message.
the time_t at which the message has been received/sent.
TRUE if the message should be flagged as read, FALSE otherwise.
TRUE if the message has been received, FALSE otherwise.
Create a message attached to a dedicated chat room;
a new
[LinphoneChatMessage]
The
[LinphoneChatRoom]
object corresponding to the conversation.
Delete all messages from the history
The
[LinphoneChatRoom]
object corresponding to the conversation.
The
[LinphoneChatMessage]
object to remove.
Delete a message from the chat room history.
[LinphoneChatRoom]
object
Destroy a LinphoneChatRoom.
Destroy a LinphoneChatRoom.
A list of
[LinphoneChatMessage]
objects.
LinphoneChatMessage
The
[LinphoneChatRoom]
object corresponding to the conversation for which messages should be retrieved
Number of message to retrieve. 0 means everything.
Gets nb_message most recent messages from cr chat room, sorted from oldest to most recent.
A list of
[LinphoneChatMessage]
objects.
LinphoneChatMessage
A list of
[LinphoneChatMessage]
objects.
LinphoneChatMessage
The
[LinphoneChatRoom]
object corresponding to the conversation for which messages should be retrieved
The first message of the range to be retrieved. History most recent message has index 0.
The last message of the range to be retrieved. History oldest message has index of history size - 1 (use
[linphone_chat_room_get_history_size]
to retrieve history size)
Gets the partial list of messages in the given range, sorted from oldest to most recent.
A list of
[LinphoneChatMessage]
objects.
LinphoneChatMessage
true if zrtp secrets have already been shared and ready to use
Returns true if lime is available for given peer
true if zrtp secrets have already been shared and ready to use
The
[LinphoneChatRoom]
object corresponding to the conversation.
Mark all messages of the conversation as read
The same chat room.
The chat room.
Acquire a reference to the chat room.
The same chat room.
LinphoneChatRoom object
LinphoneChatMessage object The state of the message sending will be notified via the callbacks defined in the LinphoneChatMessageCbs object that can be obtained by calling
[linphone_chat_message_get_callbacks()]
. The LinphoneChatMessage reference is transfered to the function and thus doesn't need to be unref'd by the application.
Send a message to peer member of this chat room.
[LinphoneChatRoom]
object
message to be sent
Send a message to peer member of this chat room.
[LinphoneChatRoom]
object
[LinphoneChatMessage]
message to be sent
LinphoneChatMessageStateChangeCb status callback invoked when message is delivered or could not be delivered. May be NULL
user data for the status cb.
Send a message to peer member of this chat room.
The LinphoneChatMessage must not be destroyed until the the callback is called. The LinphoneChatMessage reference is transfered to the function and thus doesn't need to be unref'd by the application.
LinphoneChatRoom object
LinphoneChatMessage object The state of the message sending will be notified via the callbacks defined in the LinphoneChatMessageCbs object that can be obtained by calling
[linphone_chat_message_get_callbacks()]
.
Send a message to peer member of this chat room.
The chat room.
Release reference to the chat room.
LinphoneCall or NULL.
LinphoneChatRomm
get Curent Call associated to this chatroom if any To commit a message, use
[linphone_chat_room_send_message]
LinphoneCall or NULL.
RFC 4103/T.140 char
[LinphoneChatRoom]
object
When realtime text is enabled
[linphone_call_params_realtime_text_enabled]
,
[LinphoneCoreIsComposingReceivedCb]
is call everytime a char is received from peer. At the end of remote typing a regular
[LinphoneChatMessage]
is received with committed data from
[LinphoneCoreMessageReceivedCb]
.
RFC 4103/T.140 char
Returns back pointer to
[LinphoneCore]
object.
the number of messages.
The
[LinphoneChatRoom]
object corresponding to the conversation for which size has to be computed
Gets the number of messages in a chat room.
the number of messages.
Returns back pointer to
[LinphoneCore]
object.
Returns back pointer to
[LinphoneCore]
object.
[LinphoneAddress]
peer address
[LinphoneChatRoom]
object
get peer address
[associated to ]
this
[LinphoneChatRoom]
[LinphoneAddress]
peer address
TRUE if the remote is currently composing a message, FALSE otherwise.
The
[LinphoneChatRoom]
object corresponding to the conversation.
Tells whether the remote is currently composing a message.
TRUE if the remote is currently composing a message, FALSE otherwise.
the number of unread messages.
The
[LinphoneChatRoom]
object corresponding to the conversation.
Gets the number of unread messages in the chatroom.
the number of unread messages.
The user pointer associated with the chat room.
The chat room.
Retrieve the user pointer associated with the chat room.
The user pointer associated with the chat room.
The chat room.
The user pointer to associate with the chat room.
Assign a user pointer to the chat room.
A chat room is the place where text messages are exchanged.
Can be created by linphone_core_create_chat_room().
0 if succeeded, -1 if failed
A
[LinphoneConference]
SIP URI of the participant to remove
Remove a participant from a conference
The passed SIP URI must be one of the URIs returned by
[linphone_conference_get_participants()]
0 if succeeded, -1 if failed
A list of
[LinphoneAddress]
objects.
LinphoneAddress
A
[LinphoneConference]
Get URIs of all participants of one conference The returned bctbx_list_t contains URIs of all participant. That list must be freed after use and each URI must be unref with
[linphone_address_unref()]
A list of
[LinphoneAddress]
objects.
LinphoneAddress
LinphoneConference class The _LinphoneConference struct does not exists, it's the Conference C++ class that is used behind
A freshly allocated
[LinphoneConferenceParams]
[LinphoneCore]
to use to find out the default parameters. Can be NULL.
Create a
[LinphoneConferenceParams]
with default parameters set.
A freshly allocated
[LinphoneConferenceParams]
An allocated
[LinphoneConferenceParams]
with the same parameters than params
The
[LinphoneConferenceParams]
to clone
Clone a
[LinphoneConferenceParams]
An allocated
[LinphoneConferenceParams]
with the same parameters than params
[LinphoneConferenceParams]
to free
Free a
[LinphoneConferenceParams]
if true, the video will be enable at conference starting
Check whether video will be enable at conference starting
if true, the video will be enable at conference starting
A
[LinphoneConferenceParams]
If true, video will be enabled during conference
Enable video when starting a conference
Parameters for initialization of conferences The _LinphoneConferenceParams struct does not exists, it's the ConferenceParams C++ class that is used behind
the filename of the config file to read to fill the instantiated LinphoneConfig
Instantiates a LinphoneConfig object from a user config file. The caller of this constructor owns a reference.
[linphone_config_unref()]
must be called when this object is no longer needed.
linphone_config_new_with_factory
the buffer from which the LinphoneConfig will be retrieved. We expect the buffer to be null-terminated.
Instantiates a LinphoneConfig object from a user provided buffer. The caller of this constructor owns a reference.
[linphone_config_unref()]
must be called when this object is no longer needed.
linphone_config_new_with_factory
linphone_config_new
the filename of the user config file to read to fill the instantiated LinphoneConfig
the filename of the factory config file to read to fill the instantiated LinphoneConfig
Instantiates a LinphoneConfig object from a user config file and a factory config file. The caller of this constructor owns a reference.
[linphone_config_unref()]
must be called when this object is no longer needed.
linphone_config_new
The LinphoneConfig object
Removes entries for key,value in a section.
Removes every pair of key,value in a section and remove the section.
The buffer that contains the config dump
The LinphoneConfig object
Dumps the LinphoneConfig as INI into a buffer
The buffer that contains the config dump
The buffer that contains the XML dump
The LinphoneConfig object
Dumps the LinphoneConfig as XML into a buffer
The buffer that contains the XML dump
Call a function for each entry present in a section configuration.
Call a function for each section present in the configuration.
Retrieves a default configuration item as a float, given its section, key, and default value. The default float value is returned if the config item isn't found.
Retrieves a default configuration item as an integer, given its section, key, and default value. The default integer value is returned if the config item isn't found.
Retrieves a default configuration item as a 64 bit integer, given its section, key, and default value. The default integer value is returned if the config item isn't found.
Retrieves a default configuration item as a string, given its section, key, and default value. The default value string is returned if the config item isn't found.
Retrieves a configuration item as a float, given its section, key, and default value.
The default float value is returned if the config item isn't found.
Retrieves a configuration item as an integer, given its section, key, and default value.
The default integer value is returned if the config item isn't found.
Retrieves a configuration item as a 64 bit integer, given its section, key, and default value.
The default integer value is returned if the config item isn't found.
Retrieves the overwrite flag for a config item
Retrieves the overwrite flag for a config section
TRUE if the value is successfully parsed as a range, FALSE otherwise. If FALSE is returned, min and max are filled respectively with default_min and default_max values.
Retrieves a configuration item as a range, given its section, key, and default min and max values.
TRUE if the value is successfully parsed as a range, FALSE otherwise. If FALSE is returned, min and max are filled respectively with default_min and default_max values.
Retrieves a section parameter item as a string, given its section and key. The default value string is returned if the config item isn't found.
Retrieves the skip flag for a config item
Retrieves the skip flag for a config section
Retrieves a configuration item as a string, given its section, key, and default value.
The default value string is returned if the config item isn't found.
A list of const char * objects.
const char *
A
[LinphoneConfig]
object
The section from which to retrieve a configuration item
The name of the configuration item to retrieve
A list of const char * objects.
const char *
Retrieves a configuration item as a list of strings, given its section, key, and default value. The default value is returned if the config item is not found.
A list of const char * objects.
const char *
The LinphoneConfig object
Returns 1 if a given section with a given key is present in the configuration.
Returns 1 if a given section is present in the configuration.
The LinphoneConfig object to fill with the content of the file
The filename of the config file to read to fill the LinphoneConfig
Reads a user config file and fill the LinphoneConfig with the read config values.
0 on success, -1 on failure
LinphoneConfig instance used as a reference
Name of the file where data will be read from. The name is relative to the place of the config file
Buffer where read string will be stored
Length of the buffer
Read a string from a file placed beside the Linphone configuration file
0 on success, -1 on failure
increment reference count
TRUE if file exists relative to the to the current location
TRUE if file exists relative to the to the current location
Sets a float config item
Sets an integer config item
Sets a 64 bits integer config item
Sets an integer config item, but store it as hexadecimal
Sets the overwrite flag for a config item (used when dumping config as xml)
Sets the overwrite flag for a config section (used when dumping config as xml)
Sets a range config item
Sets the skip flag for a config item (used when dumping config as xml)
Sets the skip flag for a config section (used when dumping config as xml)
Sets a string config item
A
[LinphoneConfig]
object
The name of the section to put the configuration item into
The name of the configuration item to set
A list of const char * objects.
const char *
The value to set
Sets a string list config item
Writes the config file to disk.
Decrement reference count, which will eventually free the object.
LinphoneConfig instance used as a reference
Name of the file where to write data. The name is relative to the place of the config file
String to write
Write a string in a file placed relatively with the Linphone configuration file.
a null terminated static array of strings
The LinphoneConfig object
Returns the list of sections' names in the LinphoneConfig.
a null terminated static array of strings
The LinphoneConfig object is used to manipulate a configuration file.
The format of the configuration file is a .ini like format:
sections are defined in []
each section contains a sequence of key=value pairs.
Example:
[sound]
echocanceler=1
playback_dev=ALSA:
Default
device
[video]
enabled=1
A LinphoneContent object object the part if found, NULL otherwise.
LinphoneContent object.
The name of the header to look for.
The value of the header to look for.
Find a part from a multipart content looking for a part header with a specified value.
A LinphoneContent object object the part if found, NULL otherwise.
The value of the header if found, NULL otherwise.
LinphoneContent object.
The name of the header to get the value from.
Get a custom header value of a content.
The value of the header if found, NULL otherwise.
A LinphoneContent object holding the part if found, NULL otherwise.
LinphoneContent object.
The index of the part to get.
Get a part from a multipart content according to its index.
A LinphoneContent object holding the part if found, NULL otherwise.
The same LinphoneContent object.
LinphoneContent object.
Acquire a reference to the content.
The same LinphoneContent object.
LinphoneContent object.
The content data buffer.
The size of the content data buffer.
Set the content data buffer, usually a string.
LinphoneContent object.
Release reference to the content.
The content data buffer.
LinphoneContent object.
Get the content data buffer, usually a string.
The content data buffer.
The encoding of the data buffer.
LinphoneContent object.
Get the encoding of the data buffer, for example "gzip".
The encoding of the data buffer.
LinphoneContent object.
The encoding of the data buffer.
Set the encoding of the data buffer, for example "gzip".
A boolean value telling whether the content is multipart or not.
LinphoneContent object.
Tell whether a content is a multipart content.
A boolean value telling whether the content is multipart or not.
The name of the content.
LinphoneContent object.
Get the name associated with a RCS file transfer message. It is used to store the original filename of the file to be downloaded from server.
The name of the content.
LinphoneContent object.
The name of the content.
Set the name associated with a RCS file transfer message. It is used to store the original filename of the file to be downloaded from server.
The content data buffer size.
LinphoneContent object.
Get the content data buffer size, excluding null character despite null character is always set for convenience.
The content data buffer size.
LinphoneContent object
The content data buffer size.
Set the content data size, excluding null character despite null character is always set for convenience.
The string content data buffer.
LinphoneContent object
Get the string content data buffer.
The string content data buffer.
LinphoneContent object.
The string content data buffer.
Set the string content data buffer.
The mime subtype of the content data, for example "html".
LinphoneContent object.
Get the mime subtype of the content data.
The mime subtype of the content data, for example "html".
LinphoneContent object.
The mime subtype of the content data, for example "html".
Set the mime subtype of the content data.
The mime type of the content data, for example "application".
LinphoneContent object.
Get the mime type of the content data.
The mime type of the content data, for example "application".
LinphoneContent object.
The mime type of the content data, for example "application".
Set the mime type of the content data.
The user pointer associated with the content.
LinphoneContent object.
Retrieve the user pointer associated with the content.
The user pointer associated with the content.
LinphoneContent object.
The user pointer to associate with the content.
Assign a user pointer to the content.
The LinphoneContent object holds data that can be embedded in a signaling message.
the LinphoneCore
the realm (domain) on which authentication is required.
the username that needs to be authenticated.
the domain on which authentication is required. Application shall reply to this callback using
[linphone_core_add_auth_info()]
.
Callback for requesting authentication information to application or user.
[LinphoneCore]
object
[LinphoneChatMessage]
message from which the body is received.
[LinphoneContent]
incoming content information
The number of bytes sent/received since the beginning of the transfer.
The total number of bytes to be sent/received.
File transfer progress indication callback prototype.
[LinphoneCore]
object
[LinphoneChatMessage]
message from which the body is received.
[LinphoneContent]
incoming content information
pointer to the received data
number of bytes to be read from buff. 0 means end of file.
File transfer receive callback prototype. This function is called by the core upon an incoming File transfer is started. This function may be call several time for the same file in case of large file.
[LinphoneCore]
object
[LinphoneChatMessage]
message from which the body is received.
[LinphoneContent]
outgoing content
pointer to the buffer where data chunk shall be written by the app
as input value, it represents the number of bytes expected by the framework. As output value, it means the number of bytes wrote by the application in the buffer. 0 means end of file.
File transfer send callback prototype. This function is called by the core upon an outgoing File transfer is started. This function is called until size is set to 0.
a
[LinphoneContent]
with a size equal zero
[LinphoneCore]
object
[LinphoneChatRoom]
involved in this conversation. Can be be created by the framework in case
[the from ]
is not present in any chat room.
[LinphoneAddress]
from
incoming message
Callback prototype
The path of the compressed log collection file (to be freed calling ms_free()).
Compress the log collection in a single file.
The path of the compressed log collection file (to be freed calling ms_free()).
Entirely disable logging.
LinphoneLogCollectionState value telling whether to enable log collection or not.
Enable the linphone core log collection to upload logs on a server.
a C FILE* where to fprintf logs. If null stdout is used.
Enable logs in supplied FILE*.
The address of a OrtpLogFunc callback whose protoype is typedef void (*OrtpLogFunc)(OrtpLogLevel lev, const char *fmt, va_list args);
Enable logs through the user's supplied log callback.
The state of the linphone core log collection.
Tells whether the linphone core log collection is enabled.
The state of the linphone core log collection.
a LinphoneCoreVTable structure holding your application callbacks
a path to a config file. If it does not exists it will be created. The config file is used to store all settings, call logs, friends, proxies... so that all these settings become persistent over the life of the LinphoneCore object. It is allowed to set a NULL config file. In that case LinphoneCore will not store any settings.
a path to a read-only config file that can be used to to store hard-coded preference such as proxy settings or internal preferences. The settings in this factory file always override the one in the normal config file. It is OPTIONAL, use NULL if unneeded.
an opaque user pointer that can be retrieved at any time (for example in callbacks) using
[linphone_core_get_user_data()]
.
Instanciates a LinphoneCore object.
The LinphoneCore object is the primary handle for doing all phone actions. It should be unique within your application.
linphone_core_new_with_config
a LinphoneCoreVTable structure holding your application callbacks
a pointer to an LpConfig object holding the configuration of the LinphoneCore to be instantiated.
an opaque user pointer that can be retrieved at any time (for example in callbacks) using
[linphone_core_get_user_data()]
.
Instantiates a LinphoneCore object with a given LpConfig.
The LinphoneCore object is the primary handle for doing all phone actions. It should be unique within your application.
linphone_core_new
Reset the log collection by removing the log files.
Enable logs serialization (output logs from either the thread that creates the linphone core or the thread that calls
[linphone_core_iterate()]
). Must be called before creating the linphone core.
True if tunnel support was compiled.
true if uPnP is available otherwise return false.
Return the availability of uPnP.
true if uPnP is available otherwise return false.
TRUE if VCARD is supported, FALSE otherwise.
Tells whether VCARD support is builtin.
TRUE if VCARD is supported, FALSE otherwise.
0 on success, -1 on failure
LinphoneCore object
The LinphoneCall object representing the call to be answered
Accept an incoming call.
Basically the application is notified of incoming calls within the call_state_changed callback of the
[LinphoneCoreVTable]
structure, where it will receive a LinphoneCallIncoming event with the associated LinphoneCall object. The application can later accept the call using this method.
0 on success, -1 on failure
0 if successful, -1 otherwise (actually when this function call is performed outside ot
[LinphoneCallUpdatedByRemote]
state)
LinphoneCore object
The call for which to accept an update
A LinphoneCallParams object describing the call parameters to accept
Accept call modifications initiated by other end.
This call may be performed in response to a
[LinphoneCallUpdatedByRemote]
state notification. When such notification arrives, the application can decide to call linphone_core_defer_update_call() so that it can have the time to prompt the user.
[linphone_call_get_remote_params()]
can be used to get information about the call parameters requested by the other party, such as whether a video stream is requested.
When the user accepts or refuse the change,
[linphone_core_accept_call_update()]
can be done to answer to the other party. If params is NULL, then the same call parameters established before the update request will continue to be used (no change). If params is not NULL, then the update will be accepted according to the parameters passed. Typical example is when a user accepts to start video, then params should indicate that video stream should be used (see
[linphone_call_params_enable_video()]
).
0 if successful, -1 otherwise (actually when this function call is performed outside ot
[LinphoneCallUpdatedByRemote]
state)
0 on success, -1 on failure
LinphoneCore object
The LinphoneCall object representing the call to be answered
The specific parameters for this call, for example whether video is accepted or not. Use NULL to use default parameters
Accept an incoming call, with parameters.
Basically the application is notified of incoming calls within the call_state_changed callback of the
[LinphoneCoreVTable]
structure, where it will receive a LinphoneCallIncoming event with the associated LinphoneCall object. The application can later accept the call using this method.
0 on success, -1 on failure
0 if successful, -1 otherwise
LinphoneCore object
The incoming call to accept
Accept an early media session for an incoming call. This is identical as calling
[linphone_core_accept_early_media_with_params()]
with NULL call parameters.
0 if successful, -1 otherwise
linphone_core_accept_early_media_with_params()
0 if successful, -1 otherwise
LinphoneCore object
The call to accept
The call parameters to use (can be NULL)
When receiving an incoming, accept to start a media session as early-media. This means the call is not accepted but audio & video streams can be established if the remote party supports early media. However, unlike after call acceptance, mic and camera input are not sent during early-media, though received audio & video are played normally. The call can then later be fully accepted using
[linphone_core_accept_call()]
or
[linphone_core_accept_call_with_params()]
.
0 if successful, -1 otherwise
0 if succeeded. Negative number if failed
[LinphoneCore]
Add all current calls into the conference. If no conference is running a new internal conference context is created and all current calls are added to it.
0 if succeeded. Negative number if failed
The
[LinphoneCore]
.
The
[LinphoneAuthInfo]
to add.
Adds authentication information to the
[LinphoneCore]
. That piece of information will be used during all SIP transactions that require authentication.
The
[LinphoneCore]
object to monitor.
A
[LinphoneCoreCbs]
object holding the callbakcs you need. A reference is take by
[LinphoneCore]
until you invoke linphone_core_remove_cbs().
Add a listener in order to be notified of
[LinphoneCore]
events. Once an event is received, registred
[LinphoneCoreCbs]
are sequencially invoked in order.
[LinphoneCore]
object
[LinphoneFriend]
to add
Add a friend to the current buddy list, if
[subscription attribute ]
is set, a SIP SUBSCRIBE message is sent.
LinphoneCore object
LinphoneFriendList object
Add a friend list.
object
a LinphoneCoreVTable structure holding your application callbacks. Object is owned by linphone core until linphone_core_remove_listener.
add a listener to be notified of linphone core events. Once events are received, registered vtable are invoked in order.
Add a proxy configuration. This will start registration on the proxy, if registration is enabled.
The feature tag name
This function controls signaling features supported by the core. They are typically included in a SIP Supported header.
0 if succeeded. Negative number if failed
[LinphoneCore]
The current call with the participant to add
Add a participant to the conference. If no conference is going on a new internal conference context is created and the participant is added to it.
0 if succeeded. Negative number if failed
Return TRUE if codec can be used with bandwidth, FALSE else
LinphoneCore object
Erase the call log.
Erase all proxies from config.
The create
[LinphoneAddress]
object
[LinphoneCore]
object
String containing the user supplied address
Create a
[LinphoneAddress]
object by parsing the user supplied address, given as a string.
The create
[LinphoneAddress]
object
[LinphoneAuthInfo]
with default values set
[LinphoneCore]
object
String containing the username part of the authentication credentials
String containing the username to use to calculate the authentication digest (optional)
String containing the password of the authentication credentials (optional, either passwd or ha1 must be set)
String containing a ha1 hash of the password (optional, either passwd or ha1 must be set)
String used to discriminate different SIP authentication domains (optional)
String containing the SIP domain for which this authentication information is valid, if it has to be restricted for a single SIP domain.
Create an authentication information with default values from Linphone core.
[LinphoneAuthInfo]
with default values set
A new LinphoneCallParams object
LinphoneCore object
LinphoneCall for which the parameters are to be build, or NULL in the case where the parameters are to be used for a new outgoing call.
Create a LinphoneCallParams suitable for
[linphone_core_invite_with_params()]
,
[linphone_core_accept_call_with_params()]
,
[linphone_core_accept_early_media_with_params()]
,
[linphone_core_accept_call_update()]
. The parameters are initialized according to the current LinphoneCore configuration and the current state of the LinphoneCall.
A new LinphoneCallParams object
A pointer on the freshly created conference. That object will be automatically freed by the core after calling
[linphone_core_terminate_conference()]
.
The
[LinphoneCore]
instance where the conference will be created inside.
Parameters of the conference. See
[LinphoneConferenceParams]
.
Create a conference
A pointer on the freshly created conference. That object will be automatically freed by the core after calling
[linphone_core_terminate_conference()]
.
[LinphoneCore]
object
The filename of the config file to read to fill the instantiated
[LinphoneConfig]
Create a
[LinphoneConfig]
object from a user config file.
LinphoneContent object with default values set
LinphoneCore object
Create a content with default values from Linphone core.
LinphoneContent object with default values set
The created
[LinphoneFriend]
object
[LinphoneCore]
object
Create a default LinphoneFriend.
The created
[LinphoneFriend]
object
A new LinphoneFriendList object.
LinphoneCore object.
Create a new empty LinphoneFriendList object.
A new LinphoneFriendList object.
The created
[LinphoneFriend]
object
[LinphoneCore]
object
A string containing the address to create the LinphoneFriend from
Create a LinphoneFriend from the given address.
The created
[LinphoneFriend]
object
[LinphoneCore]
object
The filename of the config file to read to fill the instantiated LpConfig
Create a LpConfig object from a user config file.
A new LinphoneNatPolicy object.
LinphoneCore object
Create a new LinphoneNatPolicy object with every policies being disabled.
A new LinphoneNatPolicy object.
A new LinphoneNatPolicy object.
LinphoneCore object
The reference of a NAT policy in the config of the LinphoneCore
Create a new LinphoneNatPolicy by reading the config of a LinphoneCore according to the passed ref.
A new LinphoneNatPolicy object.
a LinphoneEvent holding the context of the notification.
the
[LinphoneCore]
the destination resource
the event name
Create an out-of-dialog notification, specifying the destination resource, the event name. The notification can be send with
[linphone_event_notify()]
.
a LinphoneEvent holding the context of the notification.
the LinphoneEvent holding the context of the publish.
the
[LinphoneCore]
the resource uri for the event
the event name
Create a publish context for a one-shot publish. After being created, the publish must be sent using
[linphone_event_send_publish()]
. The LinphoneEvent is automatically terminated when the publish transaction is finished, either with success or failure. The application must not call
[linphone_event_terminate()]
for such one-shot publish.
the LinphoneEvent holding the context of the publish.
The created
[LinphonePresenceActivity]
object.
[LinphoneCore]
object.
The
[LinphonePresenceActivityType]
to set for the activity.
An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
Create a LinphonePresenceActivity with the given type and description.
The created
[LinphonePresenceActivity]
object.
The created
[LinphonePresenceModel]
object.
[LinphoneCore]
object.
Create a default LinphonePresenceModel.
The created
[LinphonePresenceModel]
object.
The created
[LinphonePresenceModel]
object.
[LinphoneCore]
object.
The
[LinphonePresenceActivityType]
to set for the activity of the created model.
An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
Create a LinphonePresenceModel with the given activity type and activity description.
The created
[LinphonePresenceModel]
object.
The created
[LinphonePresenceModel]
object.
[LinphoneCore]
object.
The
[LinphonePresenceActivityType]
to set for the activity of the created model.
An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
The content of the note to be added to the created model.
The language of the note to be added to the created model.
Create a LinphonePresenceModel with the given activity type, activity description, note content and note language.
The created
[LinphonePresenceModel]
object.
The created
[LinphonePresenceNote]
object.
[LinphoneCore]
object.
The content of the note to be created.
The language of the note to be created.
Create a LinphonePresenceNote with the given content and language.
The created
[LinphonePresenceNote]
object.
The created
[LinphonePresencePerson]
object.
[LinphoneCore]
object
The id of the person to be created.
Create a LinphonePresencePerson with the given id.
The created
[LinphonePresencePerson]
object.
The created
[LinphonePresenceService]
object.
[LinphoneCore]
object.
The id of the service to be created.
The basic status of the service to be created.
A string containing a contact information corresponding to the service to be created.
Create a LinphonePresenceService with the given id, basic status and contact.
The created
[LinphonePresenceService]
object.
[LinphoneProxyConfig]
with default values set
[LinphoneCore]
object
Create a proxy config with default values from Linphone core.
[LinphoneProxyConfig]
with default values set
the LinphoneEvent holding the context of the publish.
the
[LinphoneCore]
the resource uri for the event
the event name
the lifetime of event being published, -1 if no associated duration, in which case it will not be refreshed.
Create a publish context for an event state. After being created, the publish must be sent using
[linphone_event_send_publish()]
. After expiry, the publication is refreshed unless it is terminated before.
the LinphoneEvent holding the context of the publish.
a LinphoneEvent holding the context of the created subcription.
the
[LinphoneCore]
the destination resource
the event name
the whished duration of the subscription
Create an outgoing subscription, specifying the destination resource, the event name, and an optional content body. If accepted, the subscription runs for a finite period, but is automatically renewed if not terminated before. Unlike
[linphone_core_subscribe()]
the subscription isn't sent immediately. It will be send when calling
[linphone_event_send_subscribe()]
.
a LinphoneEvent holding the context of the created subcription.
0 on success, -1 on failure
LinphoneCore object
The LinphoneCall to decline, must be in the IncomingReceived state
The reason for rejecting the call: LinphoneReasonDeclined or LinphoneReasonBusy
Decline a pending incoming call, with a reason.
0 on success, -1 on failure
0 if successful, -1 if the
[linphone_core_defer_call_update()]
was done outside a valid
[LinphoneCallUpdatedByRemote]
notification
LinphoneCore object
The call for which to defer the update
When receiving a
[LinphoneCallUpdatedByRemote]
state notification, prevent LinphoneCore from performing an automatic answer.
When receiving a
[LinphoneCallUpdatedByRemote]
state notification (ie an incoming reINVITE), the default behaviour of LinphoneCore is defined by the "defer_update_default" option of the "sip" section of the config. If this option is 0 (the default) then the LinphoneCore automatically answers the reINIVTE with call parameters unchanged. However when for example when the remote party updated the call to propose a video stream, it can be useful to prompt the user before answering. This can be achieved by calling
[linphone_core_defer_call_update()]
during the call state notification, to deactivate the automatic answer that would just confirm the audio but reject the video. Then, when the user responds to dialog prompt, it becomes possible to call
[linphone_core_accept_call_update()]
to answer the reINVITE, with eventually video enabled in the LinphoneCallParams argument.
The
[LinphoneCallUpdatedByRemote]
notification can also arrive when receiving an INVITE without SDP. In such case, an unchanged offer is made in the 200Ok, and when the ACK containing the SDP answer is received,
[LinphoneCallUpdatedByRemote]
is triggered to notify the application of possible changes in the media session. However in such case defering the update has no meaning since we just generating an offer.
0 if successful, -1 if the
[linphone_core_defer_call_update()]
was done outside a valid
[LinphoneCallUpdatedByRemote]
notification
A
[LinphoneCore]
object
A
[LinphoneChatRoom]
object
Removes a chatroom including all message history from the LinphoneCore.
LinphoneCore object
Destroys a LinphoneCore
A
[LinphoneCore]
object
the deny reason (#LinphoneReasonNone has no effect).
Inconditionnaly disable incoming chat messages.
A
[LinphoneCore]
object
Enable reception of incoming chat messages. By default it is enabled but it can be disabled with
[linphone_core_disable_chat()]
.
0 if successful, any other value otherwise.
[LinphoneCore]
object.
The
[LinphonePayloadType]
to enable or disable. It can be retrieved using
[linphone_core_find_payload_type]
TRUE to enable the payload type, FALSE to disable it.
Enable or disable the use of the specified payload type.
0 if successful, any other value otherwise.
The LinphoneCore object
indicates whether video capture is enabled
indicates whether video display should be shown
Enables video globally.
This function does not have any effect during calls. It just indicates LinphoneCore to initiate future calls with video or not. The two boolean parameters indicate in which direction video is enabled. Setting both to false disables video entirely.
0 if succeeded. Negative number if failed
[LinphoneCore]
Join the local participant to the running conference
0 if succeeded. Negative number if failed
a
[LinphoneAuthInfo]
the LinphoneCore
the authentication 'realm' (optional)
the SIP username to be authenticated (mandatory)
the SIP domain name (optional)
Find authentication info matching realm, username, domain criteria. First of all, (realm,username) pair are searched. If multiple results (which should not happen because realm are supposed to be unique), then domain is added to the search.
a
[LinphoneAuthInfo]
LinphoneCall or NULL is no match is found
which should match call remote uri
Search from the list of current calls if a remote address match uri
LinphoneCall or NULL is no match is found
{LinphoneCallLog}
LinphoneCore object
Call id of the call log to find
Get the call log matching the call id, or NULL if can't be found.
{LinphoneCallLog}
The
[LinphoneFriend]
object corresponding to the given address.
[LinphoneCore]
object.
The address to use to search the friend.
Search a LinphoneFriend by its address.
The
[LinphoneFriend]
object corresponding to the given address.
Returns NULL if not found.
[LinphoneCore]
object
payload mime type (I.E SPEEX, PCMU, VP8)
can be
[LINPHONE_FIND_PAYLOAD_IGNORE_RATE]
number of channels, can be
[LINPHONE_FIND_PAYLOAD_IGNORE_CHANNELS]
Get payload type from mime type and clock rate
This function searches in audio and video codecs for the given payload type name and clockrate.
Returns NULL if not found.
LinphoneCore object
The lower bound of the audio port range being used
The upper bound of the audio port range being used
Get the audio port range from which is randomly chosen the UDP port used for audio streaming.
The call if it has been found, NULL otherwise
LinphoneCore object
The remote address of the call that we want to get
Get the call with the remote_address specified
The call if it has been found, NULL otherwise
the
[LinphoneCall]
of the call if found
Get the call with the remote_address specified
the
[LinphoneCall]
of the call if found
A list of
[LinphoneCallLog]
objects.
LinphoneCallLog
LinphoneCore object
LinphoneAddress object
Get the list of call logs (past calls) that matches the given
[LinphoneAddress]
. At the contrary of linphone_core_get_call_logs, it is your responsability to unref the logs and free this list once you are done using it.
A list of
[LinphoneCallLog]
objects.
LinphoneCallLog
[LinphoneChatRoom]
where messaging can take place.
the linphone core
a linphone address.
Get a chat room whose peer is the supplied address. If it does not exist yet, it will be created. No reference is transfered to the application. The LinphoneCore keeps a reference on the chat room.
[LinphoneChatRoom]
where messaging can take place.
[LinphoneChatRoom]
where messaging can take place.
A
[LinphoneCore]
object
The destination address for messages.
Get a chat room for messaging from a sip uri like sip:
joe@sip.linphone.org
. If it does not exist yet, it will be created. No reference is transfered to the application. The LinphoneCore keeps a reference on the chat room.
[LinphoneChatRoom]
where messaging can take place.
the default proxy configuration, that is the one used to determine the current identity.
the default proxy configuration, that is the one used to determine the current identity.
The
[LinphoneFriend]
object corresponding to the given address.
[LinphoneCore]
object.
The address to use to search the friend.
Search a LinphoneFriend by its address.
The
[LinphoneFriend]
object corresponding to the given address.
The
[LinphoneFriend]
object corresponding to the given reference key.
[LinphoneCore]
object.
The reference key to use to search the friend.
Search a LinphoneFriend by its reference key.
The
[LinphoneFriend]
object corresponding to the given reference key.
bitrate the IP bitrate in kbit/s, or -1 if an error occured.
the
[LinphoneCore]
object
the
[LinphonePayloadType]
to modify.
Get the bitrate explicitely set with
[linphone_core_set_payload_type_bitrate()]
.
bitrate the IP bitrate in kbit/s, or -1 if an error occured.
Returns the payload type number assigned for this codec.
0
LinphoneCore object
A
[LinphoneSipTransports]
structure that will receive the configured ports
Retrieves the port configuration used for each transport (udp, tcp, tls). A zero value port for a given transport means the transport is not used. A value of LC_SIP_TRANSPORT_RANDOM (-1) means the port is to be chosen randomly by the system.
0
LinphoneCore object
Retrieves the real port number assigned for each sip transport (udp, tcp, tls). A zero value means that the transport is not activated. If LC_SIP_TRANSPORT_RANDOM was passed to
[linphone_core_set_sip_transports()]
, the random port choosed by the system is returned.
LinphoneCore object
The lower bound of the text port range being used
The upper bound of the text port range being used
Get the video port range from which is randomly chosen the UDP port used for text streaming.
LinphoneCore object
The lower bound of the video port range being used
The upper bound of the video port range being used
Get the video port range from which is randomly chosen the UDP port used for video streaming.
A boolean value telling whether a call is currently running or not
LinphoneCore object
Tells whether there is a call running.
A boolean value telling whether a call is currently running or not
See linphone_proxy_config_normalize_sip_uri for documentation. Default proxy config is used to parse the address.
a LinphoneCall object or NULL in case of failure
the LinphoneCore object
the destination of the call (sip address, or phone number).
Initiates an outgoing call. The application doesn't own a reference to the returned LinphoneCall object. Use
[linphone_call_ref()]
to safely keep the
[LinphoneCall]
pointer valid within your application.
a LinphoneCall object or NULL in case of failure
A LinphoneCall object or NULL in case of failure
LinphoneCore object
The destination of the call (sip address).
Initiates an outgoing call given a destination LinphoneAddress The LinphoneAddress can be constructed directly using
[linphone_address_new()]
, or created by
[linphone_core_interpret_url()]
. The application doesn't own a reference to the returned LinphoneCall object. Use
[linphone_call_ref()]
to safely keep the LinphoneCall pointer valid within your application.
A LinphoneCall object or NULL in case of failure
A LinphoneCall object or NULL in case of failure
LinphoneCore object
The destination of the call (sip address).
Call parameters
Initiates an outgoing call given a destination LinphoneAddress The LinphoneAddress can be constructed directly using
[linphone_address_new()]
, or created by
[linphone_core_interpret_url()]
. The application doesn't own a reference to the returned LinphoneCall object. Use
[linphone_call_ref()]
to safely keep the LinphoneCall pointer valid within your application.
A LinphoneCall object or NULL in case of failure
A LinphoneCall object or NULL in case of failure
LinphoneCore object
The destination of the call (sip address, or phone number).
Initiates an outgoing call according to supplied call parameters The application doesn't own a reference to the returned LinphoneCall object. Use
[linphone_call_ref()]
to safely keep the LinphoneCall pointer valid within your application.
A LinphoneCall object or NULL in case of failure
Main loop function. It is crucial that your application call it periodically.
[linphone_core_iterate()]
performs various backgrounds tasks:
receiving of SIP messages
handles timers and timeout
performs registration to proxies
authentication retries The application MUST call this function periodically, in its main loop. Be careful that this function must be called from the same thread as other liblinphone methods. If it is not the case make sure all liblinphone calls are serialized with a mutex. For ICE to work properly it should be called every 20ms.
lc
LinphoneCore object
0 if succeeded. Negative number if failed
[LinphoneCore]
Make the local participant leave the running conference
0 if succeeded. Negative number if failed
whether a media encryption scheme is supported by the LinphoneCore engine
core
LinphoneMediaEncryption
Check if a media encryption type is supported
whether a media encryption scheme is supported by the LinphoneCore engine
the linphone core
Migrates the friends from the linphonerc to the database if not done yet
the linphone core
Migrates the call logs from the linphonerc to the database if not done yet
1 if migration was done, 0 if not done because unnecessary or already done, -1 in case of error.
the linphone core
Migrate configuration so that all SIP transports are enabled. Versions of linphone < 3.7 did not support using multiple SIP transport simultaneously. This function helps application to migrate the configuration so that all transports are enabled. Existing proxy configuration are added a transport parameter so that they continue using the unique transport that was set previously. This function must be used just after creating the core, before any call to
[linphone_core_iterate()]
1 if migration was done, 0 if not done because unnecessary or already done, -1 in case of error.
[LinphoneCore]
object
[LinphonePresenceModel]
to notify
Notify all friends that have subscribed
0
LinphoneCore object
Pause all currently running calls.
0
0 on success, -1 on failure
LinphoneCore object
The call to pause
Pauses the call. If a music file has been setup using
[linphone_core_set_play_file()]
, this file will be played to the remote user.
0 on success, -1 on failure
TRUE if the payload type is enabled, FALSE if disabled.
[LinphoneCore]
object.
The
[LinphonePayloadType]
we want to know is enabled or not.
Tells whether the specified payload type is enabled.
TRUE if the payload type is enabled, FALSE if disabled.
TRUE if the payload type represents a VBR codec, FALSE if disabled.
[LinphoneCore]
object.
The
[LinphonePayloadType]
we want to know
Tells whether the specified payload type represents a variable bitrate codec.
TRUE if the payload type represents a VBR codec, FALSE if disabled.
LinphoneCore object
DTMF to play ['0'..'16'] | '#' | '#'
Duration in ms, -1 means play until next further call to
[linphone_core_stop_dtmf()]
Plays a dtmf sound to the local user.
0 on success, -1 on error
LinphoneCore object
The path to an audio file in wav PCM 16 bit format
Plays an audio file to the local user. This function works at any time, during calls, or when no calls are running. It doesn't request the underlying audio system to support multiple playback streams.
0 on success, -1 on error
the LinphoneEvent holding the context of the publish.
the
[LinphoneCore]
the resource uri for the event
the event name
the lifetime of event being published, -1 if no associated duration, in which case it will not be refreshed.
the actual published data
Publish an event state. This first create a LinphoneEvent with
[linphone_core_create_publish()]
and calls
[linphone_event_send_publish()]
to actually send it. After expiry, the publication is refreshed unless it is terminated before.
the LinphoneEvent holding the context of the publish.
0 if successful, -1 on error.
[LinphoneCore]
object
The
[LinphoneCall]
to redirect
The URI to redirect the call to
Redirect the specified call to the given redirect URI.
0 if successful, -1 on error.
A pointer on the
[LinphoneCore]
passed as parameter.
The
[LinphoneCore]
which the ref counter is to be incremented.
Increment the reference counter of a
[LinphoneCore]
object.
A pointer on the
[LinphoneCore]
passed as parameter.
force registration refresh to be initiated upon next iterate
[LinphoneCore]
object
[LinphoneFriend]
to add
Black list a friend. same as
[linphone_friend_set_inc_subscribe_policy()]
with
[LinphoneSPDeny]
policy;
[LinphoneCore]
object.
the path from where plugins are to be loaded, pass NULL to use default (compile-time determined) plugin directory.
Reload mediastreamer2 plugins from specified directory.
[LinphoneCore]
object.
Update detection of sound devices.
Use this function when the application is notified of USB plug events, so that list of available hardwares for sound playback and capture is updated.
[LinphoneCore]
object.
Update detection of camera devices.
Use this function when the application is notified of USB plug events, so that list of available hardwares for video capture is updated.
The
[LinphoneCore]
from which the
[LinphoneAuthInfo]
will be removed.
The
[LinphoneAuthInfo]
to remove.
Removes an authentication information object.
[LinphoneCore]
object
[LinphoneCallLog]
object to remove.
Remove a specific call log from call history list. This function destroys the call log object. It must not be accessed anymore by the application after calling this function.
The
[LinphoneCore]
The pointer on the
[LinphoneCoreCbs]
to remove.
Remove a listener from a
[LinphoneCore]
[LinphoneCore]
object
[LinphoneFriend]
to remove
Removes a friend from the buddy list
LinphoneCore object
LinphoneFriendList object
Removes a friend list.
0 if successful, -1 otherwise.
the linphone core
a call that has been previously merged into the conference.
Remove a call from the conference.
In other words, unless
[linphone_core_leave_conference()]
is explicitly called, the last remote participant of a conference is automatically put in a simple call in running state.
0 if successful, -1 otherwise.
object
a LinphoneCoreVTable structure holding your application callbacks.
remove a listener registred by linphone_core_add_listener.
Removes a proxy configuration.
LinphoneCore will then automatically unregister and place the proxy configuration on a deleted list. For that reason, a removed proxy does NOT need to be freed.
The tag to remove
Remove a supported tag.
linphone_core_add_supported_tag()
[LinphoneCore]
object.
Reset the counter of missed calls.
0 on success, -1 on failure
LinphoneCore object
The call to resume
Resumes a call.
0 on success, -1 on failure
The LinphoneCore object
The dtmf name specified as a char, such as '0', '#' etc...
Send the specified dtmf.
LinphoneCore object
The lower bound of the audio port range to use
The upper bound of the audio port range to use
Sets the UDP port range from which to randomly select the port used for audio streaming.
the core
the
[LinphoneReason]
representing the failure error code.
a wav file to be played when such call failure happens.
Assign an audio file to be played locally upon call failure, for a given reason.
the
[LinphoneCore]
object
the
[LinphonePayloadType]
to modify.
the IP bitrate in kbit/s.
Set an explicit bitrate (IP bitrate, not codec bitrate) for a given codec, in kbit/s.
Force a number for a payload type. The LinphoneCore does payload type number assignment automatically. THis function is to be used mainly for tests, in order to override the automatic assignment mechanism.
[LinphoneCore]
object
how long in away
sip uri used to redirect call in state
[LinphoneStatusMoved]
[LinphoneOnlineStatus]
Set my presence status
LinphoneCore object
The lower bound of the text port range to use
The upper bound of the text port range to use
Sets the UDP port range from which to randomly select the port used for text streaming.
LinphoneCore object
The user agent name
The user agent version
Sets the user agent string used in SIP messages, ideally called just after
[linphone_core_new()]
or linphone_core_init().
LinphoneCore object
The lower bound of the video port range to use
The upper bound of the video port range to use
Sets the UDP port range from which to randomly select the port used for video streaming.
A boolean value telling whether the specified sound device can capture sound
LinphoneCore object
the device name as returned by
[linphone_core_get_sound_devices()]
Tells whether a specified sound device can capture sound.
A boolean value telling whether the specified sound device can capture sound
A boolean value telling whether the specified sound device can play sound
LinphoneCore object
the device name as returned by
[linphone_core_get_sound_devices()]
Tells whether a specified sound device can play sound.
A boolean value telling whether the specified sound device can play sound
A boolean value telling whether a call will need the sound resources in near future
LinphoneCore object
Check if a call will need the sound resources in near future (typically an outgoing call that is awaiting response). In liblinphone, it is not possible to have two independant calls using sound device or camera at the same time. In order to prevent this situation, an application can use
[linphone_core_sound_resources_locked()]
to know whether it is possible at a given time to start a new outgoing call. When the function returns TRUE, an application should not allow the user to start an outgoing call.
A boolean value telling whether a call will need the sound resources in near future
0 if succeeded. Negative number if failed
[LinphoneCore]
Path to the file where the recording will be written
Start recording the running conference
0 if succeeded. Negative number if failed
Special function to warm up dtmf feeback stream.
[linphone_core_stop_dtmf_stream]
must() be called before entering FG mode
0 if succeeded. Negative number if failed
[LinphoneCore]
Stop recording the running conference
0 if succeeded. Negative number if failed
LinphoneCore object
Stops playing a dtmf started by
[linphone_core_play_dtmf()]
.
Special function to stop dtmf feed back function. Must be called before entering BG mode
LinphoneCore object
Whenever the liblinphone is playing a ring to advertise an incoming call or ringback of an outgoing call, this function stops the ringing. Typical use is to stop ringing when the user requests to ignore the call.
a LinphoneEvent holding the context of the created subcription.
the
[LinphoneCore]
the destination resource
the event name
the whished duration of the subscription
an optional body, may be NULL.
Create an outgoing subscription, specifying the destination resource, the event name, and an optional content body. If accepted, the subscription runs for a finite period, but is automatically renewed if not terminated before.
a LinphoneEvent holding the context of the created subcription.
0 if successfull, -1 otherwise (typically if jpeg format is not supported).
the linphone core
a path where to write the jpeg content.
Take a photo of currently from capture device and write it into a jpeg file. Note that the snapshot is asynchronous, an application shall not assume that the file is created when the function returns.
0 if successfull, -1 otherwise (typically if jpeg format is not supported).
0
LinphoneCore object
Terminates all the calls.
0
0 on success, -1 on failure
LinphoneCore object
The LinphoneCall object representing the call to be terminated
Terminates a call.
0 on success, -1 on failure
0 if succeeded. Negative number if failed
[LinphoneCore]
Terminate the running conference. If it is a local conference, all calls inside it will become back separate calls and will be put in
[LinphoneCallPaused]
state. If it is a conference involving a focus server, all calls inside the conference will be terminated.
0 if succeeded. Negative number if failed
0 on success, -1 on failure
LinphoneCore object
The call to be transfered
The destination the call is to be refered to
Performs a simple call transfer to the specified destination. The remote endpoint is expected to issue a new call to the specified destination. The current call remains active and thus can be later paused or terminated. It is possible to follow the progress of the transfer provided that transferee sends notification about it. In this case, the transfer_state_changed callback of the
[LinphoneCoreVTable]
is invoked to notify of the state of the new call at the other party. The notified states are
[LinphoneCallOutgoingInit]
,
[LinphoneCallOutgoingProgress]
,
[LinphoneCallOutgoingRinging]
and
[LinphoneCallConnected]
.
0 on success, -1 on failure
0 on success, -1 on failure
LinphoneCore object
A running call you want to transfer
A running call whose remote person will receive the transfer
Transfers a call to destination of another running call. This is used for "attended transfer" scenarios. The transfered call is supposed to be in paused state, so that it is able to accept the transfer immediately. The destination call is a call previously established to introduce the transfered person. This method will send a transfer request to the transfered person. The phone of the transfered is then expected to automatically call to the destination of the transfer. The receiver of the transfer will then automatically close the call with us (the 'dest' call). It is possible to follow the progress of the transfer provided that transferee sends notification about it. In this case, the transfer_state_changed callback of the
[LinphoneCoreVTable]
is invoked to notify of the state of the new call at the other party. The notified states are
[LinphoneCallOutgoingInit]
,
[LinphoneCallOutgoingProgress]
,
[LinphoneCallOutgoingRinging]
and
[LinphoneCallConnected]
.
0 on success, -1 on failure
The
[LinphoneCore]
which the reference counter is to be decreased.
Decrement the ref counter of a
[LinphoneCore]
object and destroy it if the counter reach 0.
Updates a running call according to supplied call parameters or parameters changed in the LinphoneCore. In this version this is limited to the following use cases:
setting up/down the video stream according to the video parameter of the LinphoneCallParams (see
[linphone_call_params_enable_video()]
).
changing the size of the transmitted video after calling
[linphone_core_set_preferred_video_size()]
In case no changes are requested through the LinphoneCallParams argument, then this argument can be omitted and set to NULL.
lc
LinphoneCore object
call
The call to be updated
params
The new call parameters to use (may be NULL)
0 if successful, -1 otherwise.
LinphoneCore object
Upload the log collection to the configured server url.
[LinphoneCore]
object.
TRUE to use a separate window, FALSE to insert the preview in the remote video window.
Tells the core to use a separate window for local camera preview video, instead of inserting local view within the remote video window.
LinphoneCore object
A boolean value telling whether the tls server certificate must be verified
Specify whether the tls server certificate must be verified when connecting to a SIP/TLS server.
LinphoneCore object
A boolean value telling whether the tls server certificate common name must be verified
Specify whether the tls server certificate common name must be verified when connecting to a SIP/TLS server.
Returns which adaptive rate algorithm is currently configured for future calls.
See
[linphone_core_set_adaptive_rate_algorithm()]
.
Sets adaptive rate algorithm. It will be used for each new calls starting from now. Calls already started will not be updated.
Returns whether adaptive rate control is enabled.
See
[linphone_core_enable_adaptive_rate_control()]
.
Enable adaptive rate control.
Adaptive rate control consists in using RTCP feedback provided information to dynamically control the output bitrate of the audio and video encoders, so that we can adapt to the network conditions and available bandwidth. Control of the audio encoder is done in case of audio-only call, and control of the video encoder is done for audio & video calls. Adaptive rate control feature is enabled by default.
TRUE if the audio adaptive jitter compensation is enabled, FALSE otherwise.
[LinphoneCore]
object
Tells whether the audio adaptive jitter compensation is enabled.
TRUE if the audio adaptive jitter compensation is enabled, FALSE otherwise.
[LinphoneCore]
object
TRUE to enable the audio adaptive jitter compensation, FALSE to disable it.
Enable or disable the audio adaptive jitter compensation.
A list of PayloadType objects.
PayloadType
This list is unmodifiable. The ->data field of the bctbx_list_t points a PayloadType structure holding the codec information. It is possible to make copy of the list with bctbx_list_copy() in order to modify it (such as the order of codecs).
The LinphoneCore object
Returns the list of available audio codecs.
A list of PayloadType objects.
PayloadType
This list is unmodifiable. The ->data field of the bctbx_list_t points a PayloadType structure holding the codec information. It is possible to make copy of the list with bctbx_list_copy() in order to modify it (such as the order of codecs).
0 The list is taken by the LinphoneCore thus the application should not free it. This list is made of struct PayloadType describing the codec parameters.
The LinphoneCore object
A list of PayloadType objects.
PayloadType
Sets the list of audio codecs.
0 The list is taken by the LinphoneCore thus the application should not free it. This list is made of struct PayloadType describing the codec parameters.
The current DSCP value
LinphoneCore object
Get the DSCP field for outgoing audio streams. The DSCP defines the quality of service in IP packets.
The current DSCP value
LinphoneCore object
The DSCP value to set
Set the DSCP field for outgoing audio streams. The DSCP defines the quality of service in IP packets.
The nominal audio jitter buffer size in milliseconds
LinphoneCore object
Returns the nominal audio jitter buffer size in milliseconds.
The nominal audio jitter buffer size in milliseconds
Sets the nominal audio jitter buffer size in milliseconds. The value takes effect immediately for all running and pending calls, if any. A value of 0 disables the jitter buffer.
an ipv4/6 multicast address or default value
[LinphoneCore]
Use to get multicast address to be used for audio stream.
an ipv4/6 multicast address or default value
0 in case of success
[LinphoneCore]
an ipv4/6 multicast address
Use to set multicast address to be used for audio stream.
0 in case of success
true if subsequent calls will propose multicast ip set by
[linphone_core_set_audio_multicast_addr]
[LinphoneCore]
Use to get multicast state of audio stream.
true if subsequent calls will propose multicast ip set by
[linphone_core_set_audio_multicast_addr]
Use to enable multicast rtp for audio stream.
If enabled, outgoing calls put a multicast address from
[linphone_core_get_video_multicast_addr]
into audio cline. In case of outgoing call audio stream is sent to this multicast address.
For incoming calls behavior is unchanged.
core
[LinphoneCore]
yesno
if yes, subsequent calls will propose multicast ip set by
[linphone_core_set_audio_multicast_addr]
a time to leave value
[LinphoneCore]
Use to get multicast ttl to be used for audio stream.
a time to leave value
0 in case of success
[LinphoneCore]
value or -1 if not used. [0..255] default value is 1
Use to set multicast ttl to be used for audio stream.
0 in case of success
The UDP port used for audio streaming
LinphoneCore object
Gets the UDP port used for audio streaming.
The UDP port used for audio streaming
LinphoneCore object
The UDP port to use for audio streaming
Sets the UDP port used for audio streaming. A value of -1 will request the system to allocate the local port randomly. This is recommended in order to avoid firewall warnings.
A list of
[LinphoneAuthInfo]
objects.
LinphoneAuthInfo
The LinphoneCore object.
Returns an unmodifiable list of currently entered
[LinphoneAuthInfo]
.
A list of
[LinphoneAuthInfo]
objects.
LinphoneAuthInfo
The current AVPF mode
LinphoneCore object
Return AVPF enablement. See
[linphone_core_set_avpf_mode()]
.
The current AVPF mode
LinphoneCore object
The AVPF mode to use.
Enable RTCP feedback (also known as RTP/AVPF profile). Setting LinphoneAVPFDefault is equivalent to LinphoneAVPFDisabled. This setting can be overriden per LinphoneProxyConfig with
[linphone_proxy_config_set_avpf_mode()]
. The value set here is used for calls placed or received out of any proxy configured, or if the proxy config is configured with LinphoneAVPFDefault.
The current AVPF report interval in seconds
LinphoneCore object
Return the avpf report interval in seconds.
The current AVPF report interval in seconds
LinphoneCore object
The report interval in seconds
Set the avpf report interval in seconds. This value can be overriden by the proxy config using
[linphone_proxy_config_set_avpf_rr_interval()]
.
A list of
[LinphoneCallLog]
objects.
LinphoneCallLog
LinphoneCore object
Get the list of call logs (past calls).
A list of
[LinphoneCallLog]
objects.
LinphoneCallLog
the linphone core
filesystem path
Sets the database filename where call logs will be stored. If the file does not exist, it will be created.
A list of
[LinphoneCall]
objects.
LinphoneCall
The LinphoneCore object
Gets the current list of calls. Note that this list is read-only and might be changed by the core after a function call to
[linphone_core_iterate()]
. Similarly the LinphoneCall objects inside it might be destroyed without prior notice. To hold references to LinphoneCall object into your program, you must use
[linphone_call_ref()]
.
A list of
[LinphoneCall]
objects.
LinphoneCall
The current number of calls
LinphoneCore object
Get the number of Call
The current number of calls
The name of the currently assigned sound device for capture
LinphoneCore object
Gets the name of the currently assigned sound device for capture.
The name of the currently assigned sound device for capture
0
LinphoneCore object
The device name as returned by
[linphone_core_get_sound_devices()]
Sets the sound device used for capture.
0
file path or NULL if not exist
the linphone core
Get path to the database file used for storing chat messages.
file path or NULL if not exist
the linphone core
filesystem path
Sets the database filename where chat messages will be stored. If the file does not exist, it will be created.
A
[LinphoneCore]
object
Returns whether chat is enabled.
A list of
[LinphoneChatRoom]
objects.
LinphoneChatRoom
[LinphoneCore]
object
Returns an list of chat rooms
A list of
[LinphoneChatRoom]
objects.
LinphoneChatRoom
A pointer on
[LinphoneConference]
or NULL if no conference are going on
[LinphoneCore]
Get a pointer on the internal conference object.
A pointer on
[LinphoneConference]
or NULL if no conference are going on
A value inside [0.0 ; 1.0]
[LinphoneCore]
Get the set input volume of the local participant
A value inside [0.0 ; 1.0]
The number of participant
[LinphoneCore]
Get the number of participant in the running conference. The local participant is included in the count only if it is in the conference.
The number of participant
[LinphoneCore]
object
Returns the LpConfig object used to manage the storage (config) file.
The current call or NULL if no call is running
LinphoneCore object
Gets the current call.
The current call or NULL if no call is running
The remote address of the current call or NULL if there is no current call.
LinphoneCore object.
Get the remote address of the current call.
The remote address of the current call or NULL if there is no current call.
the
[LinphoneCoreCbs]
that has called the last callback
the linphonecore
Gets the current
[LinphoneCoreCbs]
. This is meant only to be called from a callback to be able to get the user_data associated with the
[LinphoneCoreCbs]
that is calling the callback.
the
[LinphoneCoreCbs]
that has called the last callback
a MSVideoSize
the core
Returns the effective video size for the captured video as provided by the camera. When preview is disabled or not yet started, this function returns a zeroed video size.
linphone_core_set_preview_video_size()
a MSVideoSize
the vtable that called the last callback
the linphonecore
Gets the current VTable. This is meant only to be called from a callback to be able to get the user_data associated with the vtable that called the callback.
the vtable that called the last callback
the first LinphoneFriendList object or NULL
LinphoneCore object
Retrieves the first list of LinphoneFriend from the core.
the first LinphoneFriendList object or NULL
the default proxy configuration, that is the one used to determine the current identity.
LinphoneCore object
the default proxy configuration, that is the one used to determine the current identity.
LinphoneCore object
The proxy configuration to use as the default one.
Sets the default proxy.
This default proxy must be part of the list of already entered LinphoneProxyConfig. Toggling it as default will make LinphoneCore use the identity associated with the proxy configuration in all incoming and outgoing calls.
The current delayed timeout in seconds
LinphoneCore object
Gets the delayed timeout See
[linphone_core_set_delayed_timeout()]
for details.
The current delayed timeout in seconds
LinphoneCore object
The new delayed timeout
Set the in delayed timeout in seconds. After this timeout period, a delayed call (internal call initialisation or resolution) is resumed.
The current device orientation
LinphoneCore object
Gets the current device orientation.
The current device orientation
linphone_core_set_device_rotation()
LinphoneCore object
The orientation to use
Tells the core the device current orientation. This can be used by capture filters on mobile devices to select between portrait/landscape mode and to produce properly oriented images. The exact meaning of the value in rotation if left to each device specific implementations. IOS supported values are 0 for UIInterfaceOrientationPortrait and 270 for UIInterfaceOrientationLandscapeRight.
TRUE if DNS search is enabled, FALSE if disabled.
[LinphoneCore]
object.
Tells whether DNS search (use of local domain if the fully qualified name did return results) is enabled.
TRUE if DNS search is enabled, FALSE if disabled.
[LinphoneCore]
object.
TRUE to enable DNS search, FALSE to disable it.
Enable or disable DNS search (use of local domain if the fully qualified name did return results).
[LinphoneCore]
object.
A #bctbx_list_t of strings containing the IP addresses of DNS servers to be used. Setting to NULL restores default behaviour, which is to use the DNS server list provided by the system. The list is copied internally.
Forces liblinphone to use the supplied list of dns servers, instead of system's ones.
TRUE if DNS SRV resolution is enabled, FALSE if disabled.
[LinphoneCore]
object.
Tells whether DNS SRV resolution is enabled.
TRUE if DNS SRV resolution is enabled, FALSE if disabled.
[LinphoneCore]
object.
TRUE to enable DNS SRV resolution, FALSE to disable it.
Enable or disable DNS SRV resolution.
Retrieve the maximum available download bandwidth. This value was set by
[linphone_core_set_download_bandwidth()]
.
the LinphoneCore object
the bandwidth in kbits/s, 0 for infinite
Sets maximum available download bandwidth This is IP bandwidth, in kbit/s. This information is used signaled to other parties during calls (within SDP messages) so that the remote end can have sufficient knowledge to properly configure its audio & video codec output bitrate to not overflow available bandwidth.
Get audio packetization time linphone expects to receive from peer. A value of zero means that ptime is not specified.
Set audio packetization time linphone expects to receive from peer. A value of zero means that ptime is not specified.
A boolean value telling whether echo cancellation is enabled or disabled
LinphoneCore object
Returns TRUE if echo cancellation is enabled.
A boolean value telling whether echo cancellation is enabled or disabled
LinphoneCore object
A boolean value telling whether echo cancellation is to be enabled or disabled.
Enables or disable echo cancellation. Value is saved and used for subsequent calls. This actually controls software echo cancellation. If hardware echo cancellation is available, it will be always used and activated for calls, regardless of the value passed to this function. When hardware echo cancellation is available, the software one is of course not activated.
TRUE if the echo limiter is enabled, FALSE otherwise.
[LinphoneCore]
object.
Tells whether echo limiter is enabled.
TRUE if the echo limiter is enabled, FALSE otherwise.
[LinphoneCore]
object.
TRUE to enable echo limiter, FALSE to disable it.
Enables or disable echo limiter.
URL of the file server like
https://file.linphone.org/upload.php
[LinphoneCore]
from which to get the server_url
Get the globaly set http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml.
URL of the file server like
https://file.linphone.org/upload.php
[LinphoneCore]
to be modified
URL of the file server like
https://file.linphone.org/upload.php
Globaly set an http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml. This value can also be set for a dedicated account using
[linphone_proxy_config_set_file_transfer_server]
The
[LinphoneFirewallPolicy]
that is being used.
[LinphoneCore]
object.
Get the policy that is used to pass through firewalls.
The
[LinphoneFirewallPolicy]
that is being used.
[LinphoneCore]
object.
The
[LinphoneFirewallPolicy]
to use.
Set the policy to use to pass through firewalls.
A list of
[LinphoneFriend]
objects.
LinphoneFriend
[LinphoneCore]
object
Get Buddy list of LinphoneFriend
A list of
[LinphoneFriend]
objects.
LinphoneFriend
the linphone core
filesystem path
Sets the database filename where friends will be stored. If the file does not exist, it will be created.
A list of
[LinphoneFriendList]
objects.
LinphoneFriendList
a list of LinphoneFriendList
LinphoneCore object
Retrieves the list of LinphoneFriendList from the core.
A list of
[LinphoneFriendList]
objects.
LinphoneFriendList
a list of LinphoneFriendList
Returns TRUE if hostname part of primary contact is guessed automatically.
Tells LinphoneCore to guess local hostname automatically in primary contact.
hostname of IP adress of the http proxy (can be NULL to disable).
LinphoneCore object
Get http proxy address to be used for signaling.
hostname of IP adress of the http proxy (can be NULL to disable).
LinphoneCore object
Hostname of IP adress of the http proxy (can be NULL to disable).
Set http proxy address to be used for signaling during next channel connection. Use
[linphone_core_set_network_reachable]
FASLE/TRUE to force channel restart.
port of the http proxy.
LinphoneCore object
Get http proxy port to be used for signaling.
port of the http proxy.
LinphoneCore object
of the http proxy.
Set http proxy port to be used for signaling.
The default identity SIP address
LinphoneCore object
Gets the default identity SIP address. This is an helper function. If no default proxy is set, this will return the primary contact ( see
[linphone_core_get_primary_contact()]
). If a default proxy is set it returns the registered identity on the proxy.
The default identity SIP address
the IM Encryption Engine in the core or NULL
LinphoneCore object
Gets the IM Encryption Engine in the core if possible
the IM Encryption Engine in the core or NULL
LinphoneCore object
LinphoneImEncryptionEngine object
Sets an IM Encryption Engine in the core
A LinphoneImNotifPolicy object.
LinphoneCore object
Get the LinphoneImNotifPolicy object controlling the instant messaging notifications.
A LinphoneImNotifPolicy object.
The current in call timeout in seconds
LinphoneCore object
Gets the in call timeout See
[linphone_core_set_in_call_timeout()]
for details.
The current in call timeout in seconds
LinphoneCore object
The new timeout in seconds
Set the in call timeout in seconds. After this timeout period, the call is automatically hangup.
TRUE if the local participant is in a conference, FALSE otherwise.
the linphone core
Indicates whether the local participant is part of a conference.
That function automatically fails in the case of conferences using a conferencet server (focus). If you use such a conference, you should use
[linphone_conference_remove_participant()]
instead.
TRUE if the local participant is in a conference, FALSE otherwise.
The current incoming call timeout in seconds
LinphoneCore object
Returns the incoming call timeout See
[linphone_core_set_inc_timeout()]
for details.
The current incoming call timeout in seconds
LinphoneCore object
The new timeout in seconds
Set the incoming call timeout in seconds. If an incoming call isn't answered for this timeout period, it is automatically declined.
A boolean telling whether an incoming invite is pending or not.
LinphoneCore object
Tells whether there is an incoming invite pending.
A boolean telling whether an incoming invite is pending or not.
A boolean value telling whether IPv6 is enabled or not
LinphoneCore object
Tells whether IPv6 is enabled or not.
A boolean value telling whether IPv6 is enabled or not
linphone_core_enable_ipv6() for more details on how IPv6 is supported in liblinphone.
LinphoneCore object
A boolean value telling whether to enable IPv6 support
Turns IPv6 support on or off.
A boolean value telling whether signaling keep alive is enabled
LinphoneCore object
Is signaling keep alive enabled.
A boolean value telling whether signaling keep alive is enabled
LinphoneCore object
A boolean value telling whether signaling keep alive is to be enabled
Enables signaling keep alive, small udp packet sent periodically to keep udp NAT association.
{LinphoneCallLog}
LinphoneCore object
Get the latest outgoing call log.
{LinphoneCallLog}
The max file size in bytes of the files used for log collection.
Get the max file size in bytes of the files used for log collection.
The max file size in bytes of the files used for log collection.
The max file size in bytes of the files used for log collection.
Set the max file size in bytes of the files used for log collection. Warning: this function should only not be used to change size dynamically but instead only before calling
linphone_core_enable_log_collection. If you increase max size on runtime, logs chronological order COULD be broken.
The path where the log files will be written.
Get the path where the log files will be written for log collection.
The path where the log files will be written.
The path where the log files will be written.
Set the path where the log files will be written for log collection.
The prefix of the filenames used for log collection.
Get the prefix of the filenames that will be used for log collection.
The prefix of the filenames used for log collection.
The prefix to use for the filenames for log collection.
Set the prefix of the filenames that will be used for log collection.
LinphoneCore object
The url of the server where to upload the collected log files.
Set the url of the server where to upload the collected log files.
A pointer to the FILE structure of the file to write to.
Define a log file.
If the file pointer passed as an argument is NULL, stdout is used instead.
The function pointer of the log handler.
Define a log handler.
Minimum level for logging messages.
Define the minimum level for logging.
A bitmask of the log levels to set.
Define the log level using mask.
The loglevel parameter is a bitmask parameter. Therefore to enable only warning and error messages, use ORTP_WARNING | ORTP_ERROR. To disable logs, simply set loglevel to 0.
max number of simultaneous calls
core
Get the maximum number of simultaneous calls Linphone core can manage at a time. All new call above this limit are declined with a busy answer
max number of simultaneous calls
core
number of simultaneous calls
Set the maximum number of simultaneous calls Linphone core can manage at a time. All new call above this limit are declined with a busy answer
The media encryption policy being used.
[LinphoneCore]
object.
Get the media encryption policy being used for RTP packets.
The media encryption policy being used.
0 if successful, any other value otherwise.
[LinphoneCore]
object.
The media encryption policy to be used.
Choose the media encryption policy to be used for RTP packets.
0 if successful, any other value otherwise.
TRUE means the call will fail; FALSE means an INVITE will be resent with encryption disabled.
[LinphoneCore]
object.
Get behaviour when encryption parameters negociation fails on outgoing call.
TRUE means the call will fail; FALSE means an INVITE will be resent with encryption disabled.
[LinphoneCore]
object.
If set to TRUE call will fail; if set to FALSE will resend an INVITE with encryption disabled.
Define behaviour when encryption parameters negociation fails on outgoing call.
This method is called by the application to notify the linphone core library when the media (RTP) network is reachable. This is for advanced usage, when SIP and RTP layers are required to use different interfaces. Most applications just need
[linphone_core_set_network_reachable()]
.
TRUE if the microphone is enabled, FALSE if disabled.
[LinphoneCore]
object
Tells whether the microphone is enabled.
TRUE if the microphone is enabled, FALSE if disabled.
[LinphoneCore]
object
TRUE to enable the microphone, FALSE to disable it.
Enable or disable the microphone.
The current microphone gain
LinphoneCore object
Get microphone gain in db.
The current microphone gain
LinphoneCore object
The new microphone level
Allow to control microphone level: gain in db.
The number of missed calls.
[LinphoneCore]
object.
Get the number of missed calls. Once checked, this counter can be reset with
[linphone_core_reset_missed_calls_count()]
.
The number of missed calls.
LinphoneCore object
The MTU in bytes
Sets the maximum transmission unit size in bytes. This information is useful for sending RTP packets. Default value is 1500.
The public IP address of NAT being used.
[LinphoneCore]
object.
Get the public IP address of NAT being used.
The public IP address of NAT being used.
[LinphoneCore]
object.
The public IP address of NAT to use.
Set the public IP address of NAT when using the firewall policy is set to use NAT.
LinphoneNatPolicy object in use.
[LinphoneCore]
object
Get The policy that is used to pass through NATs/firewalls. It may be overridden by a NAT policy for a specific proxy config.
LinphoneNatPolicy object in use.
linphone_proxy_config_get_nat_policy()
[LinphoneCore]
object
LinphoneNatPolicy object
Set the policy to use to pass through NATs/firewalls. It may be overridden by a NAT policy for a specific proxy config.
linphone_proxy_config_set_nat_policy()
The native window handle of the video preview window
LinphoneCore object
Get the native window handle of the video preview window.
The native window handle of the video preview window
LinphoneCore object
The native window id where the preview video is to be displayed
Set the native window id where the preview video (local camera) is to be displayed. This has to be used in conjonction with
[linphone_core_use_preview_window()]
. MacOS, Linux, Windows: if not set or zero the core will create its own window, unless the special id -1 is given.
The native window handle of the video window
LinphoneCore object
Get the native window handle of the video window.
The native window handle of the video window
Set the native video window id where the video is to be displayed. For MacOS, Linux, Windows: if not set or LINPHONE_VIDEO_DISPLAY_AUTO the core will create its own window, unless the special id LINPHONE_VIDEO_DISPLAY_NONE is given.
return network state either as positioned by the application or by linphone itself.
This method is called by the application to notify the linphone core library when network is reachable. Calling this method with true trigger linphone to initiate a registration process for all proxies. Calling this method disables the automatic network detection mode. It means you must call this method after each network state changes.
a OrtpNetworkSimulatorParams structure.
Get the previously set network simulation parameters.
linphone_core_set_network_simulator_params
a OrtpNetworkSimulatorParams structure.
0 if successful, -1 otherwise.
the LinphoneCore
the parameters used for the network simulation.
Set the network simulator parameters. Liblinphone has the capabability of simulating the effects of a network (latency, lost packets, jitter, max bandwidth). Please refer to the oRTP documentation for the meaning of the parameters of the OrtpNetworkSimulatorParams structure. This function has effect for future calls, but not for currently running calls, though this behavior may be changed in future versions.
Due to design of network simulation in oRTP, simulation is applied independently for audio and video stream. This means for example that a bandwidth limit of 250kbit/s will have no effect on an audio stream running at 40kbit/s while a videostream targetting 400kbit/s will be highly affected.
0 if successful, -1 otherwise.
The value of the no-rtp timeout in seconds
LinphoneCore object
Gets the value of the no-rtp timeout.
When no RTP or RTCP packets have been received for a while LinphoneCore will consider the call is broken (remote end crashed or disconnected from the network), and thus will terminate the call. The no-rtp timeout is the duration above which the call is considered broken.
The value of the no-rtp timeout in seconds
LinphoneCore object
The no-rtp timeout value to use in seconds
Sets the no-rtp timeout value in seconds.
linphone_core_get_nortp_timeout() for details.
The path to the file that is played when putting somebody on hold.
LinphoneCore object
Get the wav file that is played when putting somebody on hold, or when files are used instead of soundcards (see
[linphone_core_set_use_files()]
).
The file is a 16 bit linear wav file.
The path to the file that is played when putting somebody on hold.
LinphoneCore object
The path to the file to be played when putting somebody on hold.
Sets a wav file to be played when putting somebody on hold, or when files are used instead of soundcards (see
[linphone_core_set_use_files()]
).
The file must be a 16 bit linear wav file.
Get playback sound level in 0-100 scale.
Set sound playback level in 0-100 scale.
The name of the currently assigned sound device for playback
LinphoneCore object
Gets the name of the currently assigned sound device for playback.
The name of the currently assigned sound device for playback
0
LinphoneCore object
The device name as returned by
[linphone_core_get_sound_devices()]
Sets the sound device used for playback.
0
The current playback gain
LinphoneCore object
Get playback gain in db before entering sound card.
The current playback gain
LinphoneCore object
The new play level
Allow to control play level before entering sound card: gain in db
frame rate in number of frames per seconds.
the linphone core
Returns the preferred video framerate, previously set by
[linphone_core_set_preferred_framerate()]
.
frame rate in number of frames per seconds.
the LinphoneCore
the target frame rate in number of frames per seconds.
Set the preferred frame rate for video. Based on the available bandwidth constraints and network conditions, the video encoder remains free to lower the framerate. There is no warranty that the preferred frame rate be the actual framerate. used during a call. Default value is 0, which means "use encoder's default fps value".
Returns the current preferred video size for sending.
Sets the preferred video size.
This applies only to the stream that is captured and sent to the remote party, since we accept all standard video size on the receive path.
Sets the preferred video size by its name.
This is identical to
[linphone_core_set_preferred_video_size()]
except that it takes the name of the video resolution as input. Video resolution names are: qcif, svga, cif, vga, 4cif, svga ...
[LinphoneOnlineStatus]
[LinphoneCore]
object
Get my presence status
[LinphoneOnlineStatus]
A
[LinphonePresenceModel]
object, or NULL if no presence model has been set.
[LinphoneCore]
object
Get my presence model
A
[LinphonePresenceModel]
object, or NULL if no presence model has been set.
[LinphoneCore]
object
[LinphonePresenceModel]
Set my presence model
a MSVideoSize
the core
Returns video size for the captured video if it was previously set by
[linphone_core_set_preview_video_size()]
, otherwise returns a 0,0 size.
linphone_core_set_preview_video_size()
a MSVideoSize
the linphone core
the video resolution choosed for capuring and previewing. It can be (0,0) to not request any specific preview size and let the core optimize the processing.
Sets the video size for the captured (preview) video. This method is for advanced usage where a video capture must be set independently of the size of the stream actually sent through the call. This allows for example to have the preview window with HD resolution even if due to bandwidth constraint the sent video size is small. Using this feature increases the CPU consumption, since a rescaling will be done internally.
Sets the preview video size by its name. See
[linphone_core_set_preview_video_size()]
for more information about this feature.
Video resolution names are: qcif, svga, cif, vga, 4cif, svga ...
Returns the default identity when no proxy configuration is used.
Sets the local "from" identity.
This data is used in absence of any proxy configuration or when no default proxy configuration is set. See LinphoneProxyConfig
Same as
[linphone_core_get_primary_contact()]
but the result is a LinphoneAddress object instead of const char*
the provisioning URI.
the linphone core
Get provisioning URI.
the provisioning URI.
-1 if uri could not be parsed, 0 otherwise. Note that this does not check validity of URI endpoint nor scheme and download may still fail.
the linphone core
the http or https uri to use in order to download the configuration. Passing NULL will disable remote provisioning.
Set URI where to download xml configuration file at startup. This can also be set from configuration file or factory config file, from [misc] section, item "config-uri". Calling this function does not load the configuration. It will write the value into configuration so that configuration from remote URI will take place at next LinphoneCore start.
-1 if uri could not be parsed, 0 otherwise. Note that this does not check validity of URI endpoint nor scheme and download may still fail.
A list of
[LinphoneProxyConfig]
objects.
LinphoneProxyConfig
The LinphoneCore object
Returns an unmodifiable list of entered proxy configurations.
A list of
[LinphoneProxyConfig]
objects.
LinphoneProxyConfig
true if realtime text is enabled, false otherwise
LinphoneCore object
Gets if realtime text is enabled or not
true if realtime text is enabled, false otherwise
Get sound capture level in 0-100 scale.
Set sound capture level in 0-100 scale.
The path to the file where incoming stream is recorded.
LinphoneCore object
Get the wav file where incoming stream is recorded, when files are used instead of soundcards (see
[linphone_core_set_use_files()]
).
This feature is different from call recording (
[linphone_call_params_set_record_file()]
) The file is a 16 bit linear wav file.
The path to the file where incoming stream is recorded.
LinphoneCore object
The path to the file where incoming stream is to be recorded.
Sets a wav file where incoming stream is to be recorded, when files are used instead of soundcards (see
[linphone_core_set_use_files()]
).
This feature is different from call recording (
[linphone_call_params_set_record_file()]
) The file will be a 16 bit linear wav file.
[LinphoneCore]
object
Get the ring back tone played to far end during incoming calls.
[LinphoneCore]
object
The path to the ring back tone to be played.
Specify a ring back tone to be played to far end during incoming calls.
The path to the wav file used for ringing
LinphoneCore object
Returns the path to the wav file used for ringing.
The path to the wav file used for ringing
LinphoneCore object
The path to a wav file to be used for ringing
Sets the path to a wav file used for ringing. The file must be a wav 16bit linear. Local ring is disabled if null.
[LinphoneCore]
object
A boolean value telling whether to enable ringing during an incoming early media call.
Enable or disable the ring play during an incoming early media call.
Get ring sound level in 0-100 scale.
Set sound ring level in 0-100 scale.
The path to the wav file used for ringing back
LinphoneCore object
Returns the path to the wav file used for ringing back.
The path to the wav file used for ringing back
LinphoneCore object
The path to a wav file to be used for ringing back
Sets the path to a wav file used for ringing back. Ringback means the ring that is heard when it's ringing at the remote party. The file must be a wav 16bit linear.
The name of the currently assigned sound device for ringing
LinphoneCore object
Gets the name of the currently assigned sound device for ringing.
The name of the currently assigned sound device for ringing
0
LinphoneCore object
The device name as returned by
[linphone_core_get_sound_devices()]
Sets the sound device used for ringing.
0
The path to a file or folder containing the trusted root CAs
LinphoneCore object
Gets the path to a file or folder containing the trusted root CAs (PEM format)
The path to a file or folder containing the trusted root CAs
LinphoneCore object
The path to a file or folder containing trusted root CAs
Sets the path to a file or folder containing trusted root CAs (PEM format)
LinphoneCore object
The trusted root CAs as a string
Sets the trusted root CAs (PEM format)
true if INVITE has to be sent whitout SDP.
Media offer control param for SIP INVITE.
true if INVITE has to be sent whitout SDP.
the linphone core
true if INVITE has to be sent whitout SDP.
Control when media offer is sent in SIP INVITE.
A boolean value telling whether self view is enabled
Refer to
LinphoneCore object
Tells whether video self view during call is enabled or not.
A boolean value telling whether self view is enabled
Refer to
[linphone_core_enable_self_view()]
for details.
LinphoneCore object
A boolean value telling whether to enable self view
Enables or disable self view during calls.
The current DSCP value
LinphoneCore object
Get the DSCP field for SIP signaling channel. The DSCP defines the quality of service in IP packets.
The current DSCP value
LinphoneCore object
The DSCP value to set
Set the DSCP field for SIP signaling channel. The DSCP defines the quality of service in IP packets.
This method is called by the application to notify the linphone core library when the SIP network is reachable. This is for advanced usage, when SIP and RTP layers are required to use different interfaces. Most applications just need
[linphone_core_set_network_reachable()]
.
The UDP port used by SIP
LinphoneCore object
Gets the UDP port used by SIP.
The UDP port used by SIP
LinphoneCore object
The UDP port to be used by SIP
Sets the UDP port to be used by SIP.
The SIP transport timeout in milliseconds.
[LinphoneCore]
object.
Get the SIP transport timeout.
The SIP transport timeout in milliseconds.
[LinphoneCore]
object.
The SIP transport timeout in milliseconds.
Set the SIP transport timeout.
0
LinphoneCore object
A LCSipTransports structure giving the ports to use
Sets the ports to be used for each of transport (UDP or TCP) A zero value port for a given transport means the transport is not used. A value of LC_SIP_TRANSPORT_RANDOM (-1) means the port is to be choosen randomly by the system.
0
An unmodifiable array of strings contanining the names of the available sound devices that is NULL terminated
LinphoneCore object
Gets the list of the available sound devices.
An unmodifiable array of strings contanining the names of the available sound devices that is NULL terminated
The path to the image file streamed when "Static picture" is set as the video device.
[LinphoneCore]
object.
Get the path to the image file streamed when "Static picture" is set as the video device.
The path to the image file streamed when "Static picture" is set as the video device.
[LinphoneCore]
object.
The path to the image file to use.
Set the path to the image file to stream when "Static picture" is set as the video device.
The frame rate used for static picture.
[LinphoneCore]
object.
Get the frame rate for static picture
The frame rate used for static picture.
[LinphoneCore]
object.
The new frame rate to use for static picture.
Set the frame rate for static picture.
The STUN server address being used.
[LinphoneCore]
object
Get the STUN server address being used.
The STUN server address being used.
[LinphoneCore]
object
The STUN server address to use.
Set the STUN server address to use when the firewall policy is set to STUN.
the supported formats, typically 'wav' and 'mkv'
the core
Returns a null terminated table of strings containing the file format extension supported for call recording.
the supported formats, typically 'wav' and 'mkv'
Returns the zero terminated table of supported video resolutions.
A list of PayloadType objects.
PayloadType
This list is unmodifiable. The ->data field of the bctbx_list_t points a PayloadType structure holding the codec information. It is possible to make copy of the list with bctbx_list_copy() in order to modify it (such as the order of codecs).
The LinphoneCore object
Returns the list of available text codecs.
A list of PayloadType objects.
PayloadType
This list is unmodifiable. The ->data field of the bctbx_list_t points a PayloadType structure holding the codec information. It is possible to make copy of the list with bctbx_list_copy() in order to modify it (such as the order of codecs).
The UDP port used for text streaming
LinphoneCore object
Gets the UDP port used for text streaming.
The UDP port used for text streaming
LinphoneCore object
The UDP port to use for text streaming
Sets the UDP port used for text streaming. A value if -1 will request the system to allocate the local port randomly. This is recommended in order to avoid firewall warnings.
the TLS certificate or NULL if not set yet
LinphoneCore object
Gets the TLS certificate
the TLS certificate or NULL if not set yet
LinphoneCore object
the TLS certificate
Sets a TLS certificate used for TLS authentication The certificate won't be stored, you have to set it after each LinphoneCore startup
the TLS certificate path or NULL if not set yet
LinphoneCore object
Gets the path to the TLS certificate file
the TLS certificate path or NULL if not set yet
LinphoneCore object
path to the TLS certificate
Sets a TLS certificate path used for TLS authentication The path will be stored in the rc file and automatically restored on startup
the TLS key or NULL if not set yet
LinphoneCore object
Gets the TLS key
the TLS key or NULL if not set yet
LinphoneCore object
the TLS key
Sets a TLS key used for TLS authentication The key won't be stored, you have to set it after each LinphoneCore startup
the TLS key path or NULL if not set yet
LinphoneCore object
Gets the path to the TLS key file
the TLS key path or NULL if not set yet
LinphoneCore object
path to the TLS key
Sets a TLS key path used for TLS authentication The path will be stored in the rc file and automatically restored on startup
LinphoneTunnel or NULL if not available
core object
get tunnel instance if available
LinphoneTunnel or NULL if not available
Retrieve the maximum available upload bandwidth. This value was set by
[linphone_core_set_upload_bandwidth()]
.
the LinphoneCore object
the bandwidth in kbits/s, 0 for infinite
Sets maximum available upload bandwidth This is IP bandwidth, in kbit/s. This information is used by liblinphone together with remote side available bandwidth signaled in SDP messages to properly configure audio & video codec's output bitrate.
Set audio packetization time linphone will send (in absence of requirement from peer) A value of 0 stands for the current codec default packetization time.
Set audio packetization time linphone will send (in absence of requirement from peer) A value of 0 stands for the current codec default packetization time.
a null terminated string containing the external ip address. If the the external ip address is not available return null.
[LinphoneCore]
Return the external ip address of router. In some cases the uPnP can have an external ip address but not a usable uPnP (state different of Ok).
a null terminated string containing the external ip address. If the the external ip address is not available return null.
an LinphoneUpnpState.
[LinphoneCore]
Return the internal state of uPnP.
an LinphoneUpnpState.
A boolean value representing whether linphone is streaming audio from and to files or not.
LinphoneCore object
Gets whether linphone is currently streaming audio from and to files, rather than using the soundcard.
A boolean value representing whether linphone is streaming audio from and to files or not.
LinphoneCore object
A boolean value asking to stream audio from and to files or not.
Ask the core to stream audio from and to files, instead of using the soundcard.
A boolean value telling whether SIP INFO is used to send digits
LinphoneCore object
Indicates whether SIP INFO is used to send digits.
A boolean value telling whether SIP INFO is used to send digits
LinphoneCore object
A boolean value telling whether to use SIP INFO to send digits
Sets whether SIP INFO is to be used to send digits.
A boolean value telling whether RFC2833 is used to send digits
LinphoneCore object
Indicates whether RFC2833 is used to send digits.
A boolean value telling whether RFC2833 is used to send digits
LinphoneCore object
A boolean value telling whether to use RFC2833 to send digits
Sets whether RFC2833 is to be used to send digits.
liblinphone's user agent as a string.
liblinphone's user agent as a string.
The path to the directory storing the user's certificates.
[LinphoneCore]
object.
Get the path to the directory storing the user's certificates.
The path to the directory storing the user's certificates.
[LinphoneCore]
object
The path to the directory to use to store the user's certificates.
Set the path to the directory storing the user's x509 certificates (used by dtls)
The user data associated with the LinphoneCore object
LinphoneCore object
Retrieves the user pointer that was given to
[linphone_core_new()]
The user data associated with the LinphoneCore object
LinphoneCore object
The user data to associate with the LinphoneCore object
Associate a user pointer to the linphone core.
Returns liblinphone's version as a string.
TRUE if the video adaptive jitter compensation is enabled, FALSE otherwise.
[LinphoneCore]
object
Tells whether the video adaptive jitter compensation is enabled.
TRUE if the video adaptive jitter compensation is enabled, FALSE otherwise.
[LinphoneCore]
object
TRUE to enable the video adaptive jitter compensation, FALSE to disable it.
Enable or disable the video adaptive jitter compensation.
TRUE if video capture is enabled, FALSE if disabled.
[LinphoneCore]
object.
Tells whether video capture is enabled.
TRUE if video capture is enabled, FALSE if disabled.
[LinphoneCore]
object.
TRUE to enable video capture, FALSE to disable it.
Enable or disable video capture.
This function does not have any effect during calls. It just indicates the
[LinphoneCore]
to initiate future calls with video capture or not.
A list of PayloadType objects.
PayloadType
This list is unmodifiable. The ->data field of the bctbx_list_t points a PayloadType structure holding the codec information. It is possible to make copy of the list with bctbx_list_copy() in order to modify it (such as the order of codecs).
The LinphoneCore object
Returns the list of available video codecs.
A list of PayloadType objects.
PayloadType
This list is unmodifiable. The ->data field of the bctbx_list_t points a PayloadType structure holding the codec information. It is possible to make copy of the list with bctbx_list_copy() in order to modify it (such as the order of codecs).
0
The list is taken by the LinphoneCore thus the application should not free it. This list is made of struct PayloadType describing the codec parameters.
The LinphoneCore object
A list of PayloadType objects.
PayloadType
Sets the list of video codecs.
0
The list is taken by the LinphoneCore thus the application should not free it. This list is made of struct PayloadType describing the codec parameters.
The name of the currently active video device
LinphoneCore object
Returns the name of the currently active video device.
The name of the currently active video device
LinphoneCore object
The name of the video device to use as returned by
[linphone_core_get_video_devices()]
Sets the active video device.
An unmodifiable array of strings contanining the names of the available video capture devices that is NULL terminated
LinphoneCore object
Gets the list of the available video capture devices.
An unmodifiable array of strings contanining the names of the available video capture devices that is NULL terminated
TRUE if video display is enabled, FALSE if disabled.
[LinphoneCore]
object.
Tells whether video display is enabled.
TRUE if video display is enabled, FALSE if disabled.
[LinphoneCore]
object.
TRUE to enable video display, FALSE to disable it.
Enable or disable video display.
This function does not have any effect during calls. It just indicates the
[LinphoneCore]
to initiate future calls with video display or not.
Get the name of the mediastreamer2 filter used for rendering video.
Set the name of the mediastreamer2 filter to be used for rendering video. This is for advanced users of the library, mainly to workaround hardware/driver bugs.
The current DSCP value
LinphoneCore object
Get the DSCP field for outgoing video streams. The DSCP defines the quality of service in IP packets.
The current DSCP value
LinphoneCore object
The DSCP value to set
Set the DSCP field for outgoing video streams. The DSCP defines the quality of service in IP packets.
Returns TRUE if either capture or display is enabled, FALSE otherwise. same as (
[linphone_core_video_capture_enabled]
|
[linphone_core_video_display_enabled]
)
The nominal video jitter buffer size in milliseconds
LinphoneCore object
Returns the nominal video jitter buffer size in milliseconds.
The nominal video jitter buffer size in milliseconds
Sets the nominal video jitter buffer size in milliseconds. The value takes effect immediately for all running and pending calls, if any. A value of 0 disables the jitter buffer.
an ipv4/6 multicast address, or default value
[LinphoneCore]
Use to get multicast address to be used for video stream.
an ipv4/6 multicast address, or default value
0 in case of success
[LinphoneCore]
an ipv4/6 multicast address
Use to set multicast address to be used for video stream.
0 in case of success
true if subsequent calls will propose multicast ip set by
[linphone_core_set_video_multicast_addr]
[LinphoneCore]
Use to get multicast state of video stream.
true if subsequent calls will propose multicast ip set by
[linphone_core_set_video_multicast_addr]
[LinphoneCore]
if yes, subsequent outgoing calls will propose multicast ip set by
[linphone_core_set_video_multicast_addr]
Use to enable multicast rtp for video stream. If enabled, outgoing calls put a multicast address from
[linphone_core_get_video_multicast_addr]
into video cline. In case of outgoing call video stream is sent to this multicast address.
For incoming calls behavior is unchanged.
a time to leave value
[LinphoneCore]
Use to get multicast ttl to be used for video stream.
a time to leave value
0 in case of success
[LinphoneCore]
value or -1 if not used. [0..255] default value is 1
Use to set multicast ttl to be used for video stream.
0 in case of success
The video policy being used
LinphoneCore object
Get the default policy for video. See
[linphone_core_set_video_policy()]
for more details.
The video policy being used
Sets the default policy for video. This policy defines whether:
video shall be initiated by default for outgoing calls
video shall be accepter by default for incoming calls
lc
LinphoneCore object
policy
The video policy to use
The UDP port used for video streaming
LinphoneCore object
Gets the UDP port used for video streaming.
The UDP port used for video streaming
LinphoneCore object
The UDP port to use for video streaming
Sets the UDP port used for video streaming. A value of -1 will request the system to allocate the local port randomly. This is recommended in order to avoid firewall warnings.
The name of the video preset used for video calls (can be NULL if the default video preset is used).
LinphoneCore object
Get the video preset used for video calls.
The name of the video preset used for video calls (can be NULL if the default video preset is used).
LinphoneCore object
The name of the video preset to be used (can be NULL to use the default video preset).
Set the video preset to be used for video calls.
A boolean value telling whether video preview is enabled
LinphoneCore object
Tells whether video preview is enabled.
A boolean value telling whether video preview is enabled
LinphoneCore object
A boolean value telling whether the video preview is to be shown
Controls video preview enablement.
[LinphoneCore]
object
TRUE to enable video source reuse. FALSE to disable it for subsequent calls.
Enable or disable video source reuse when switching from preview to actual video call.
This source reuse is useful when you always display the preview, even before calls are initiated. By keeping the video source for the transition to a real video call, you will smooth out the source close/reopen cycle.
This function does not have any effect durfing calls. It just indicates the
[LinphoneCore]
to initiate future calls with video source reuse or not. Also, at the end of a video call, the source will be closed whatsoever for now.
The path to the file storing the zrtp secrets cache.
[LinphoneCore]
object.
Get the path to the file storing the zrtp secrets cache.
The path to the file storing the zrtp secrets cache.
[LinphoneCore]
object
The path to the file to use to store the zrtp secrets cache.
Set the path to the file storing the zrtp secrets cache.
Linphone core main object created by function
[linphone_core_new()]
.
the LinphoneCore
a LinphoneAuthInfo pre-filled with username, realm and domain values as much as possible
the type of authentication requested Application shall reply to this callback using
[linphone_core_add_auth_info()]
.
Callback for requesting authentication information to application or user.
Callback prototype
the LinphoneCore
the call on which encryption is changed.
whether encryption is activated.
an authentication_token, currently set for ZRTP kind of encryption only.
Call encryption changed callback.
the LinphoneCore
the new call log entry added.
Callback to notify a new call-log entry has been added. This is done typically when a call terminates.
the LinphoneCore
the call object whose state is changed.
the new state of the call
a non NULL informational message about the state.
Call state notification callback.
the LinphoneCore
the call
the call statistics.
Callback for receiving quality statistics for calls.
the LinphoneCore
informational message.
Callback prototype for configuring status changes notification
the linphone core
the call that received the dtmf
the ascii code of the dtmf
Callback for being notified of DTMFs received.
LinphoneCore object
LinphoneFriendList object
Callback prototype for reporting when a friend list has been added to the core friends list.
LinphoneCore object
LinphoneFriendList object
Callback prototype for reporting when a friend list has been removed from the core friends list.
the
[LinphoneCore]
.
the global state
informational message.
Global state notification callback.
the LinphoneCore
the call whose info message belongs to.
the info message.
Callback prototype for receiving info messages.
[LinphoneCore]
object
[LinphoneChatRoom]
involved in the conversation.
Is composing notification callback prototype.
LinphoneCore object
Callback prototype for reporting log collection upload progress indication.
LinphoneCore object
The state of the log collection upload
Additional information: error message in case of error state, URL of uploaded file in case of success.
Callback prototype for reporting log collection upload state change.
[LinphoneCore]
object
[LinphoneChatRoom]
involved in this conversation. Can be be created by the framework in case
[the from ]
is not present in any chat room.
Chat message callback prototype
the LinphoneCore
true if network is reachable.
Callback prototype for reporting network change either automatically detected or notified by
[linphone_core_set_network_reachable]
.
[LinphoneCore]
object
[LinphoneFriend]
corresponding to the subscriber
of the subscriber Callback prototype
Reports that a new subscription request has been received and wait for a decision. Status on this subscription request is notified by
[changing policy ]
for this friend
[LinphoneCore]
object .
Updated
[LinphoneFriend]
.
Report status change for a friend previously
[added ]
to
[LinphoneCore]
.
[LinphoneCore]
object
[LinphoneFriend]
object
The URI or phone number for which teh presence model has changed
The new presence model
Reports presence model change for a specific URI or phone number of a friend
Callback prototype for notifying the application about notification received from the network.
Callback prototype for notifying the application about changes of publish states.
Callback prototype
Registration state notification callback prototype
Callback prototype for notifying the application about changes of subscription states, including arrival of new subscriptions.
the LinphoneCore
the call that was transfered
the state of the call to transfer target at the far end.
Callback for notifying progresses of transfers.
Increment the reference counter.
Decrement the reference counter.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsAuthenticationRequestedCb]
callback.'
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsBuddyInfoUpdatedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsCallEncryptionChangedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsCallLogUpdatedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsCallStateChangedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsCallStatsUpdatedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsConfiguringStatusCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsDtmfReceivedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsFriendListCreatedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsFriendListRemovedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsInfoReceivedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsIsComposingReceivedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsLogCollectionUploadProgressIndicationCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsLogCollectionUploadStateChangedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsMessageReceivedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsNetworkReachableCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsNewSubscriptionRequestedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsNotifyPresenceReceivedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsNotifyPresenceReceivedForUriOrTelCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsNotifyReceivedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsPublishStateChangedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsReferReceivedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsRegistrationStateChangedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsSubscriptionStateChangedCb]
callback.
A
[LinphoneCoreCbs]
.
The callback.
Set the
[LinphoneCoreCbsTransferStateChangedCb]
callback.
Get the user pointer.
Set private data to be get from each callbacks.
That class holds all the callbacks which are called by
[LinphoneCore]
.
Use
[linphone_factory_create_core_cbs()]
to create an instance. Then, call the callback setters on the events you need to monitor and pass the object to a
[LinphoneCore]
instance through
[linphone_core_add_listener()]
.
That class is inherited from #belle_sip_object_t.
newly allocated vtable
Instantiate a vtable with all arguments set to NULL
newly allocated vtable
to be destroyed
Destroy a vtable.
the data attached to the vtable
the vtable
Gets a user data pointer in the vtable.
the data attached to the vtable
the vtable
the user data to attach
Sets a user data pointer in the vtable.
This structure holds all callbacks that the application should implement. None is mandatory.
More details about the failure
ErrorInfo object
Provides additional information regarding the failure. With SIP protocol, the "Reason" and "Warning" headers are returned.
More details about the failure
The error phrase
ErrorInfo object
Get textual phrase from the error info. This is the text that is provided by the peer in the protocol (SIP).
The error phrase
The status code
ErrorInfo object
Get the status code from the low level protocol (ex a SIP status code).
The status code
A
[LinphoneReason]
ErrorInfo object
Get reason code from the error info.
A
[LinphoneReason]
Object representing full details about a signaling error or status. All LinphoneErrorInfo 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.
Accept an incoming subcription.
the LinphoneEvent
header's name
the header's value.
Add a custom header to an outgoing susbscription or publish.
Deny an incoming subscription with given reason.
the header's value or NULL if such header doesn't exist.
the LinphoneEvent
header's name
Obtain the value of a given header for an incoming subscription.
the header's value or NULL if such header doesn't exist.
0 if successful, -1 otherwise.
a
[LinphoneEvent]
corresponding to an incoming subscription previously received and accepted.
an optional body containing the actual notification data.
Send a notification.
0 if successful, -1 otherwise.
[LinphoneEvent]
object.
Prevent an event from refreshing its publish. This is useful to let registrations to expire naturally (or) when the application wants to keep control on when refreshes are sent. The refreshing operations can be resumed with
[linphone_proxy_config_refresh_register()]
.
Increase reference count of LinphoneEvent. By default LinphoneEvents created by the core are owned by the core only. An application that wishes to retain a reference to it must call
[linphone_event_ref()]
. When this reference is no longer needed,
[linphone_event_unref()]
must be called.
0 if successful, -1 otherwise.
LinphoneEvent object.
Refresh an outgoing publish keeping the same body.
0 if successful, -1 otherwise.
0 if successful, -1 otherwise.
LinphoneEvent object.
Refresh an outgoing subscription keeping the same body.
0 if successful, -1 otherwise.
the
[LinphoneEvent]
the new data to be published
Send a publish created by
[linphone_core_create_publish()]
.
0 if successful, -1 otherwise.
the LinphoneEvent
optional content to attach with the subscription.
Send a subscription previously created by
[linphone_core_create_subscribe()]
.
0 if successful, -1 otherwise.
Terminate an incoming or outgoing subscription that was previously acccepted, or a previous publication. The LinphoneEvent shall not be used anymore after this operation, unless the application explicitely took a reference on the object with
[linphone_event_ref()]
.
Decrease reference count.
linphone_event_ref()
the
[LinphoneEvent]
the new data to be published
Update (refresh) a publish.
a LinphoneEvent
an optional body to include in the subscription update, may be NULL.
Update (refresh) an outgoing subscription, changing the body.
Returns back pointer to the LinphoneCore that created this LinphoneEvent
Get full details about an error occured.
Get the "from" address of the subscription.
Get the name of the event as specified in the event package RFC.
Get publish state. If the event object was not created by a publish mechanism,
[LinphonePublishNone]
is returned.
Return reason code (in case of error state reached).
Get the resource address of the subscription or publish.
Get subscription direction. If the object wasn't created by a subscription mechanism,
[LinphoneSubscriptionInvalidDir]
is returned.
Get subscription state. If the event object was not created by a subscription mechanism,
[LinphoneSubscriptionNone]
is returned.
Retrieve user pointer.
Set a user (application) pointer.
Object representing an event state, which is subcribed or published.
linphone_core_publish()
linphone_core_subscribe()
A pointer on the
[LinphoneFactory]
Create the
[LinphoneFactory]
if that has not been done and return a pointer on it.
A pointer on the
[LinphoneFactory]
A new
[LinphoneAddress]
.
The
[LinphoneFactory]
singleton.
A string holding the SIP URI to parse.
Parse a string holding a SIP URI and create the according
[LinphoneAddress]
object.
A new
[LinphoneAddress]
.
A
[LinphoneAuthInfo]
object.
[linphone_auth_info_destroy()]
must be used to destroy it when no longer needed. The LinphoneCore makes a copy of LinphoneAuthInfo passed through
[linphone_core_add_auth_info()]
.
The
[LinphoneFactory]
singleton.
The username that needs to be authenticated
The userid used for authenticating (use NULL if you don't know what it is)
The password in clear text
The ha1-encrypted password if password is not given in clear text.
The authentication domain (which can be larger than the sip domain. Unfortunately many SIP servers don't use this parameter.
The SIP domain for which this authentication information is valid, if it has to be restricted for a single SIP domain.
Creates a
[LinphoneAuthInfo]
object. The object can be created empty, that is with all arguments set to NULL. Username, userid, password, realm and domain can be set later using specific methods. At the end, username and passwd (or ha1) are required.
A
[LinphoneAuthInfo]
object.
[linphone_auth_info_destroy()]
must be used to destroy it when no longer needed. The LinphoneCore makes a copy of LinphoneAuthInfo passed through
[linphone_core_add_auth_info()]
.
The
[LinphoneFactory]
singleton.
a
[LinphoneCoreCbs]
object holding your application callbacks. A reference will be taken on it until the destruciton of the core or the unregistration with linphone_core_remove_cbs().
a path to a config file. If it does not exists it will be created. The config file is used to store all settings, call logs, friends, proxies... so that all these settings become persistent over the life of the LinphoneCore object. It is allowed to set a NULL config file. In that case LinphoneCore will not store any settings.
a path to a read-only config file that can be used to to store hard-coded preference such as proxy settings or internal preferences. The settings in this factory file always override the one in the normal config file. It is OPTIONAL, use NULL if unneeded.
Instanciate a
[LinphoneCore]
object.
The LinphoneCore object is the primary handle for doing all phone actions. It should be unique within your application.
linphone_core_new_with_config
a new #LinponeCoreCbs.
Instanciate a
[LinphoneCoreCbs]
object.
a new #LinponeCoreCbs.
The
[LinphoneFactory]
singleton. The LinphoneCore object is the primary handle for doing all phone actions. It should be unique within your application.
a
[LinphoneCoreCbs]
object holding your application callbacks. A reference will be taken on it until the destruciton of the core or the unregistration with linphone_core_remove_cbs().
a pointer to an LpConfig object holding the configuration of the LinphoneCore to be instantiated.
Instantiates a LinphoneCore object with a given LpConfig.
linphone_core_new
a new
[LinphoneVcard]
.
Create an empty
[LinphoneVcard]
.
a new
[LinphoneVcard]
.
[LinphoneFactory]
is a singleton object devoted to the creation of all the object of Liblinphone that cannot created by
[LinphoneCore]
or
[LinphoneCore]
itself.
a new empty
[LinphoneFriend]
Contructor
a new empty
[LinphoneFriend]
a new
[LinphoneFriend]
with
[vCard initialized ]
a vCard object
Contructor same as
[linphone_friend_new()]
+
[linphone_friend_set_address()]
a new
[LinphoneFriend]
with
[vCard initialized ]
a new
[LinphoneFriend]
with
[address initialized ]
a buddy address, must be a sip uri like sip:
joe@sip.linphone.org
Contructor same as
[linphone_friend_new()]
+
[linphone_friend_set_address()]
a new
[LinphoneFriend]
with
[address initialized ]
[LinphoneFriend]
object
[LinphoneAddress]
object
Adds an address in this friend
[LinphoneFriend]
object
number to add
Adds a phone number in this friend
true if the vCard has been created, false if it wasn't possible (for exemple if name and the friend's SIP URI are null or if the friend's SIP URI doesn't have a display name), or if there is already one vcard
LinphoneFriend object
The full name of the friend or NULL to use the one from the friend's SIP URI
Creates a vCard object associated to this friend if there isn't one yet and if the full name is available, either by the parameter or the one in the friend's SIP URI
true if the vCard has been created, false if it wasn't possible (for exemple if name and the friend's SIP URI are null or if the friend's SIP URI doesn't have a display name), or if there is already one vcard
LinphoneFriend object
Destroy a LinphoneFriend.
[LinphoneFriend]
object
Commits modification made to the friend configuration.
Starts editing a friend configuration.
Because friend configuration must be consistent, applications MUST call
[linphone_friend_edit()]
before doing any attempts to modify friend configuration (such as
[address ]
or
[subscription policy]
and so on). Once the modifications are done, then the application must call
[linphone_friend_done()]
to commit the changes.
A
[LinphonePresenceModel]
object, or NULL if the friend do not have presence information for this SIP URI or phone number
A
[LinphoneFriend]
object
The SIP URI or phone number for which to get the presence model
Get the presence model for a specific SIP URI or phone number of a friend
A
[LinphonePresenceModel]
object, or NULL if the friend do not have presence information for this SIP URI or phone number
TRUE if the friend is in a friend list, FALSE otherwise.
[LinphoneFriend]
object.
Check that the given friend is in a friend list.
TRUE if the friend is in a friend list, FALSE otherwise.
The same LinphoneFriend object
LinphoneFriend object
Acquire a reference to the linphone friend.
The same LinphoneFriend object
[LinphoneFriend]
object
[LinphoneAddress]
object
Removes an address in this friend
[LinphoneFriend]
object
number to remove
Removes a phone number in this friend
the linphone friend to save
the linphone core
Saves a friend either in database if configured, otherwise in linphonerc
A
[LinphoneFriend]
object
The SIP URI or phone number for which to set the presence model
The
[LinphonePresenceModel]
object to set
Set the presence model for a specific SIP URI or phone number of a friend
LinphoneFriend object
Release a reference to the linphone friend.
[LinphoneAddress]
[LinphoneFriend]
object
Get address of this friend.
the LinphoneAddress object returned is hold by the LinphoneFriend, however calling several time this function may return different objects.
[LinphoneAddress]
[LinphoneFriend]
object
[LinphoneAddress]
Set
[LinphoneAddress]
for this friend
A list of
[LinphoneAddress]
objects.
LinphoneAddress
[LinphoneFriend]
object
Returns a list of
[LinphoneAddress]
for this friend
A list of
[LinphoneAddress]
objects.
LinphoneAddress
LinphoneFriend object
Returns the LinphoneCore object managing this friend, if any.
[LinphoneSubscribePolicy]
[LinphoneFriend]
object
get current subscription policy for this
[LinphoneFriend]
[LinphoneSubscribePolicy]
[LinphoneFriend]
object
[LinphoneSubscribePolicy]
policy to apply.
Configure incoming subscription policy for this friend.
The display name of this friend
[LinphoneFriend]
object
Get the display name for this friend
The display name of this friend
[LinphoneFriend]
object
Set the display name for this friend
A list of const char * objects.
const char *
[LinphoneFriend]
object
Returns a list of phone numbers for this friend
A list of const char * objects.
const char *
A
[LinphonePresenceModel]
object, or NULL if the friend do not have presence information (in which case he is considered offline)
A
[LinphoneFriend]
object
Get the presence model of a friend
A
[LinphonePresenceModel]
object, or NULL if the friend do not have presence information (in which case he is considered offline)
A
[LinphoneFriend]
object
The
[LinphonePresenceModel]
object to set for the friend
Set the presence model of a friend
TRUE if presence information has been received for the friend, FALSE otherwise.
A
[LinphoneFriend]
object
Tells whether we already received presence information for a friend.
TRUE if presence information has been received for the friend, FALSE otherwise.
The reference key of the friend.
[LinphoneFriend]
object.
Get the reference key of a friend.
The reference key of the friend.
[LinphoneFriend]
object.
The reference key to use for the friend.
Set the reference key of a friend.
[LinphoneOnlineStatus]
A
[LinphoneFriend]
object
Get the status of a friend
[LinphoneOnlineStatus]
returns true is subscription is activated for this friend
[LinphoneFriend]
object
get subscription flag value
returns true is subscription is activated for this friend
[LinphoneFriend]
object
if TRUE this friend will receive subscription message
Configure
[LinphoneFriend]
to subscribe to presence information
[LinphoneSubscriptionState]
A
[LinphoneFriend]
object
Get subscription state of a friend
[LinphoneSubscriptionState]
Retrieve user data associated with friend.
Store user pointer to friend object.
LinphoneFriend object
Returns the vCard object associated to this friend, if any
LinphoneFriend object
The vCard object to bind
Binds a vCard object to a friend
Represents a buddy, all presence actions like subscription and status change notification are performed on this object
LinphoneFriendListOK if successfully added, LinphoneFriendListInvalidFriend if the friend is not valid.
LinphoneFriendList object.
LinphoneFriend object to add to the friend list.
Add a friend to a friend list. If or when a remote CardDAV server will be attached to the list, the friend will be sent to the server.
LinphoneFriendListOK if successfully added, LinphoneFriendListInvalidFriend if the friend is not valid.
LinphoneFriendListOK if successfully added, LinphoneFriendListInvalidFriend if the friend is not valid.
LinphoneFriendList object.
LinphoneFriend object to add to the friend list.
Add a friend to a friend list. The friend will never be sent to a remote CardDAV server. Warning! LinphoneFriends added this way will be removed on the next synchronization, and the callback contact_deleted will be called.
LinphoneFriendListOK if successfully added, LinphoneFriendListInvalidFriend if the friend is not valid.
the LinphoneFriendList object
the path to a file that will contain the vCards
Creates and export LinphoneFriend objects from LinphoneFriendList to a file using vCard 4 format
A LinphoneFriend if found, NULL otherwise.
LinphoneFriendList object.
LinphoneAddress object of the friend we want to search for.
Find a friend in the friend list using a LinphoneAddress.
A LinphoneFriend if found, NULL otherwise.
A LinphoneFriend if found, NULL otherwise.
LinphoneFriendList object.
The ref key string of the friend we want to search for.
Find a friend in the friend list using a ref key.
A LinphoneFriend if found, NULL otherwise.
A LinphoneFriend if found, NULL otherwise.
LinphoneFriendList object.
A string containing the URI of the friend we want to search for.
Find a friend in the friend list using an URI string.
A LinphoneFriend if found, NULL otherwise.
the amount of linphone friends created
the LinphoneFriendList object
the buffer that contains the vCard(s) to parse
Creates and adds LinphoneFriend objects to LinphoneFriendList from a buffer that contains the vCard(s) to parse
the amount of linphone friends created
the amount of linphone friends created
the LinphoneFriendList object
the path to a file that contains the vCard(s) to parse
Creates and adds LinphoneFriend objects to LinphoneFriendList from a file that contains the vCard(s) to parse
the amount of linphone friends created
LinphoneFriendList object.
LinphonePresenceModel object.
Notify our presence to all the friends in the friend list that have subscribed to our presence directly (not using a RLS).
The same LinphoneFriendList object.
LinphoneFriendList object.
Acquire a reference to the friend list.
The same LinphoneFriendList object.
LinphoneFriendListOK if removed successfully, LinphoneFriendListNonExistentFriend if the friend is not in the list.
LinphoneFriendList object.
LinphoneFriend object to remove from the friend list.
Remove a friend from a friend list.
LinphoneFriendListOK if removed successfully, LinphoneFriendListNonExistentFriend if the friend is not in the list.
LinphoneFriendList object.
Starts a CardDAV synchronization using value set using linphone_friend_list_set_uri.
LinphoneFriendList object.
Release reference to the friend list.
LinphoneFriendList object.
Goes through all the LinphoneFriend that are dirty and does a CardDAV PUT to update the server.
LinphoneFriendList object.
The revision
Sets the revision from the last synchronization.
the friend list
Update presence subscriptions for the entire list. Calling this function is necessary when list subscriptions are enabled, ie when a RLS presence server is used.
The LinphoneFriendListCbs object associated with the LinphoneFriendList.
LinphoneFriendList object
Get the LinphoneFriendListCbs object associated with a LinphoneFriendList.
The LinphoneFriendListCbs object associated with the LinphoneFriendList.
a LinphoneCore object
LinphoneFriendList object.
Returns the LinphoneCore object attached to this LinphoneFriendList.
a LinphoneCore object
The display name of the friend list.
LinphoneFriendList object.
Get the display name of the friend list.
The display name of the friend list.
LinphoneFriendList object.
The new display name of the friend list.
Set the display name of the friend list.
A list of
[LinphoneFriend]
objects.
LinphoneFriend
a list of LinphoneFriend
LinphoneFriendList object
Retrieves the list of LinphoneFriend from this LinphoneFriendList.
A list of
[LinphoneFriend]
objects.
LinphoneFriend
a list of LinphoneFriend
The RLS URI associated with the friend list.
LinphoneFriendList object.
Get the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
The RLS URI associated with the friend list.
LinphoneFriendList object.
The RLS URI to associate with the friend list.
Set the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
The RLS URI associated with the friend list.
LinphoneFriendList object.
Get the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
The RLS URI associated with the friend list.
LinphoneFriendList object.
The RLS URI to associate with the friend list.
Set the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
the LinphoneFriendList object
should subscription be enabled or not
Enable subscription to NOTIFYes of all friends list
The URI associated with the friend list.
LinphoneFriendList object.
Get the URI associated with the friend list.
The URI associated with the friend list.
LinphoneFriendList object.
The URI to associate with the friend list.
Set the URI associated with the friend list.
The user pointer associated with the friend list.
LinphoneFriendList object.
Retrieve the user pointer associated with the friend list.
The user pointer associated with the friend list.
LinphoneFriendList object.
The user pointer to associate with the friend list.
Assign a user pointer to the friend list.
The LinphoneFriendList object representing a list of friends.
The LinphoneFriendList object the new contact is added to
The LinphoneFriend object that has been created
Callback used to notify a new contact has been created on the CardDAV server and downloaded locally
The LinphoneFriendList object a contact has been removed from
The LinphoneFriend object that has been deleted
Callback used to notify a contact has been deleted on the CardDAV server
The LinphoneFriendList object in which a contact has been updated
The new LinphoneFriend object corresponding to the updated contact
The old LinphoneFriend object before update
Callback used to notify a contact has been updated on the CardDAV server
The LinphoneFriendList object for which the status has changed
The new synchronisation status
An additional information on the status update
Callback used to notify the status of the synchronization has changed
The same LinphoneFriendListCbs object.
LinphoneFriendListCbs object.
Acquire a reference to a LinphoneFriendListCbs object.
The same LinphoneFriendListCbs object.
LinphoneFriendListCbs object.
Release a reference to a LinphoneFriendListCbs object.
The current contact created callback.
LinphoneFriendListCbs object.
Get the contact created callback.
The current contact created callback.
LinphoneFriendListCbs object.
The contact created to be used.
Set the contact created callback.
The current contact deleted callback.
LinphoneFriendListCbs object.
Get the contact deleted callback.
The current contact deleted callback.
LinphoneFriendListCbs object.
The contact deleted to be used.
Set the contact deleted callback.
The current contact updated callback.
LinphoneFriendListCbs object.
Get the contact updated callback.
The current contact updated callback.
LinphoneFriendListCbs object.
The contact updated to be used.
Set the contact updated callback.
The current sync status changedcallback.
LinphoneFriendListCbs object.
Get the sync status changed callback.
The current sync status changedcallback.
LinphoneFriendListCbs object.
The sync status changed to be used.
Set the contact updated callback.
The user pointer associated with the LinphoneFriendListCbs object.
LinphoneFriendListCbs object.
Retrieve the user pointer associated with a LinphoneFriendListCbs object.
The user pointer associated with the LinphoneFriendListCbs object.
LinphoneFriendListCbs object.
The user pointer to associate with the LinphoneFriendListCbs object.
Assign a user pointer to a LinphoneFriendListCbs object.
An object to handle the callbacks for LinphoneFriend synchronization.
The same LinphoneImEncryptionEngine object.
LinphoneImEncryptionEngine object.
Acquire a reference to the LinphoneImEncryptionEngine.
The same LinphoneImEncryptionEngine object.
LinphoneImEncryptionEngine object.
Release reference to the LinphoneImEncryptionEngine.
the LinphoneImEncryptionEngineCbs object
the LinphoneImEncryptionEngine object
Gets the LinphoneImEncryptionEngineCbs object that holds the callbacks
the LinphoneImEncryptionEngineCbs object
The LinphoneCore object that created the IM encryption engine
LinphoneImEncryptionEngine object
Gets the LinphoneCore object that created the IM encryption engine
The LinphoneCore object that created the IM encryption engine
the user data
the LinphoneImEncryptionEngine
Gets the user data in the LinphoneImEncryptionEngine object
the user data
the LinphoneImEncryptionEngine object
the user data
Sets the user data in the LinphoneImEncryptionEngine object
IM encryption engine.
-1 if nothing to be done, 0 on success or an integer > 0 for error
LinphoneImEncryptionEngine object
LinphoneChatMessage object
Encrypted data buffer
Size of the encrypted data buffer
Buffer in which to write the decrypted data
Callback to decrypt downloading file
-1 if nothing to be done, 0 on success or an integer > 0 for error
LinphoneImEncryptionEngine object
LinphoneChatRoom object
LinphoneChatMessage object
Callback to generate the key used to encrypt the files before uploading them Key can be stored in the LinphoneContent object inside the LinphoneChatMessage using linphone_content_set_key
-1 if nothing to be done, 0 on success or an integer > 0 for error
ImEncryptionEngine object
LinphoneChatRoom object
LinphoneChatMessage object
Callback to decrypt incoming LinphoneChatMessage
-1 if nothing to be done, 0 on success or an integer > 0 for error
TRUE if files will be encrypted, FALSE otherwise
LinphoneImEncryptionEngine object
LinphoneChatRoom object
Callback to know whether or not the engine will encrypt files before uploading them
TRUE if files will be encrypted, FALSE otherwise
-1 if nothing to be done, 0 on success or an integer > 0 for error
LinphoneImEncryptionEngine object
LinphoneChatRoom object
LinphoneChatMessage object
Callback to encrypt outgoing LinphoneChatMessage
-1 if nothing to be done, 0 on success or an integer > 0 for error
-1 if nothing to be done, 0 on success or an integer > 0 for error
LinphoneImEncryptionEngine object
LinphoneChatMessage object
The current offset of the upload
Encrypted data buffer
Size of the plain data buffer and the size of the encrypted data buffer once encryption is done
Buffer in which to write the encrypted data
Callback to encrypt uploading file
-1 if nothing to be done, 0 on success or an integer > 0 for error
The same LinphoneImEncryptionEngineCbs object.
LinphoneImEncryptionEngineCbs object.
Acquire a reference to the LinphoneImEncryptionEngineCbs.
The same LinphoneImEncryptionEngineCbs object.
LinphoneImEncryptionEngineCbs object.
Release reference to the LinphoneImEncryptionEngineCbs.
the callback
the LinphoneImEncryptionEngineCbs object
Gets the callback that will generate the key to encrypt the file before uploading it
the callback
the LinphoneImEncryptionEngineCbs object
the callback to call
Sets the callback that will generate the key to encrypt the file before uploading it
the callback
the LinphoneImEncryptionEngineCbs object
Gets the callback telling wheter or not to encrypt the files
the callback
the LinphoneImEncryptionEngineCbs object
the callback to call
Sets the callback telling wheter or not to encrypt the files
the callback
the LinphoneImEncryptionEngineCbs object
Gets the callback that will decrypt the files while downloading them
the callback
the LinphoneImEncryptionEngineCbs object
the callback to call
Sets the callback that will decrypt the files while downloading them
the callback
the LinphoneImEncryptionEngineCbs object
Gets the callback that will decrypt the chat messages upon reception
the callback
the LinphoneImEncryptionEngineCbs object
the callback to call
Sets the callback that will decrypt the chat messages upon reception
the callback
the LinphoneImEncryptionEngineCbs object
Gets the callback that will encrypt the chat messages before sending them
the callback
the LinphoneImEncryptionEngineCbs object
the callback to call
Sets the callback that will encrypt the chat messages before sending them
the callback
the LinphoneImEncryptionEngineCbs object
Gets the callback that will will encrypt the files while uploading them
the callback
the LinphoneImEncryptionEngineCbs object
the callback to call
Sets the callback that will encrypt the files while uploading them
the user data
the LinphoneImEncryptionEngineCbs
Gets the user data in the LinphoneImEncryptionEngineCbs object
the user data
the LinphoneImEncryptionEngineCbs object
the user data
Sets the user data in the LinphoneImEncryptionEngineCbs object
An object to handle the callbacks for the handling a LinphoneImEncryptionEngine object.
LinphoneImNotifPolicy object.
Clear an IM notif policy (deactivate all receiving and sending of notifications).
LinphoneImNotifPolicy object.
Enable all receiving and sending of notifications.
The same LinphoneImNotifPolicy object.
LinphoneImNotifPolicy object.
Acquire a reference to the LinphoneImNotifPolicy object.
The same LinphoneImNotifPolicy object.
LinphoneImNotifPolicy object.
Release reference to the LinphoneImNotifPolicy object.
Boolean value telling whether imdn delivered notifications are being notified when received.
LinphoneImNotifPolicy object
Tell whether imdn delivered notifications are being notified when received.
Boolean value telling whether imdn delivered notifications are being notified when received.
LinphoneImNotifPolicy object
Boolean value telling whether to notify received imdn delivered notifications.
Enable imdn delivered notifications receiving.
Boolean value telling whether imdn displayed notifications are being notified when received.
LinphoneImNotifPolicy object
Tell whether imdn displayed notifications are being notified when received.
Boolean value telling whether imdn displayed notifications are being notified when received.
LinphoneImNotifPolicy object
Boolean value telling whether to notify received imdn displayed notifications.
Enable imdn displayed notifications receiving.
Boolean value telling whether is_composing notifications are being notified when received.
LinphoneImNotifPolicy object
Tell whether is_composing notifications are being notified when received.
Boolean value telling whether is_composing notifications are being notified when received.
LinphoneImNotifPolicy object
Boolean value telling whether to notify received is_composing notifications.
Enable is_composing notifications receiving.
Boolean value telling whether imdn delivered notifications are being sent.
LinphoneImNotifPolicy object
Tell whether imdn delivered notifications are being sent.
Boolean value telling whether imdn delivered notifications are being sent.
LinphoneImNotifPolicy object
Boolean value telling whether to send imdn delivered notifications.
Enable imdn delivered notifications sending.
Boolean value telling whether imdn displayed notifications are being sent.
LinphoneImNotifPolicy object
Tell whether imdn displayed notifications are being sent.
Boolean value telling whether imdn displayed notifications are being sent.
LinphoneImNotifPolicy object
Boolean value telling whether to send imdn displayed notifications.
Enable imdn displayed notifications sending.
Boolean value telling whether is_composing notifications are being sent.
LinphoneImNotifPolicy object
Tell whether is_composing notifications are being sent.
Boolean value telling whether is_composing notifications are being sent.
LinphoneImNotifPolicy object
Boolean value telling whether to send is_composing notifications.
Enable is_composing notifications sending.
The user pointer associated with the LinphoneImNotifPolicy object.
LinphoneImNotifPolicy object.
Retrieve the user pointer associated with the LinphoneImNotifPolicy object.
The user pointer associated with the LinphoneImNotifPolicy object.
LinphoneImNotifPolicy object.
The user pointer to associate with the LinphoneImNotifPolicy object.
Assign a user pointer to the LinphoneImNotifPolicy object.
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).
LinphoneNatPolicy object.
Clear a NAT policy (deactivate all protocols and unset the STUN server).
The same LinphoneNatPolicy object.
LinphoneNatPolicy object.
Acquire a reference to the LinphoneNatPolicy object.
The same LinphoneNatPolicy object.
LinphoneNatPolicy object
Start a STUN server DNS resolution.
LinphoneNatPolicy object.
Release reference to the LinphoneNatPolicy object.
Boolean value telling whether ICE is enabled.
LinphoneNatPolicy object
Tell whether ICE is enabled.
Boolean value telling whether ICE is enabled.
LinphoneNatPolicy object
Boolean value telling whether to enable ICE.
Enable ICE. ICE can be enabled without STUN/TURN, in which case only the local candidates will be used.
Boolean value telling whether STUN is enabled.
LinphoneNatPolicy object
Tell whether STUN is enabled.
Boolean value telling whether STUN is enabled.
LinphoneNatPolicy object
Boolean value telling whether to enable STUN.
Enable STUN. If TURN is also enabled, TURN will be used instead of STUN.
The STUN server used by this NAT policy.
LinphoneNatPolicy object
Get the STUN/TURN server to use with this NAT policy. Used when STUN or TURN are enabled.
The STUN server used by this NAT policy.
LinphoneNatPolicy object
The STUN server to use with this NAT policy.
Set the STUN/TURN server to use with this NAT policy. Used when STUN or TURN are enabled.
addrinfo representation of the STUN server address.
LinphoneNatPolicy object
Get the addrinfo representation of the STUN server address. WARNING: This function may block for up to 1 second.
addrinfo representation of the STUN server address.
The username used to authenticate with the STUN/TURN server.
LinphoneNatPolicy object
Get the username used to authenticate with the STUN/TURN server. The authentication will search for a LinphoneAuthInfo with this username. If it is not set the username of the currently used LinphoneProxyConfig is used to search for a LinphoneAuthInfo.
The username used to authenticate with the STUN/TURN server.
LinphoneNatPolicy object
The username used to authenticate with the STUN/TURN server.
Set the username used to authenticate with the STUN/TURN server. The authentication will search for a LinphoneAuthInfo with this username. If it is not set the username of the currently used LinphoneProxyConfig is used to search for a LinphoneAuthInfo.
Boolean value telling whether TURN is enabled.
LinphoneNatPolicy object
Tell whether TURN is enabled.
Boolean value telling whether TURN is enabled.
LinphoneNatPolicy object
Boolean value telling whether to enable TURN.
Enable TURN. If STUN is also enabled, it is ignored and TURN is used.
Boolean value telling whether uPnP is enabled.
LinphoneNatPolicy object
Tell whether uPnP is enabled.
Boolean value telling whether uPnP is enabled.
LinphoneNatPolicy object
Boolean value telling whether to enable uPnP.
Enable uPnP. This has the effect to disable every other policies (ICE, STUN and TURN).
The user pointer associated with the LinphoneNatPolicy object.
LinphoneNatPolicy object.
Retrieve the user pointer associated with the LinphoneNatPolicy object.
The user pointer associated with the LinphoneNatPolicy object.
LinphoneNatPolicy object.
The user pointer to associate with the LinphoneNatPolicy object.
Assign a user pointer to the LinphoneNatPolicy object.
Policy to use to pass through NATs/firewalls.
The number of channels.
LinphonePayloadType object
Get the number of channels.
The number of channels.
The mime type.
LinphonePayloadType object
Get the mime type.
The mime type.
The normal bitrate in bits/s.
LinphonePayloadType object
Get the normal bitrate in bits/s.
The normal bitrate in bits/s.
The type of payload.
LinphonePayloadType object
Get the type of payload.
The type of payload.
Object representing an RTP payload type.
the player.
Close the player.
The player
Destroy a player.
0 if successful, -1 otherwise
the player
file to open.
a user-data provided in the callback to help the application to retrieve its context.
Open a new source on this player.
0 if successful, -1 otherwise
0 if successful, -1 otherwise
the player.
Suspend a play operation. The player must have been started previously with
[linphone_player_start()]
.
0 if successful, -1 otherwise
0 if successful, -1 otherwise
the player.
the position to seek to.
Seek at a given position given in milliseconds. The player must be in the paused state.
0 if successful, -1 otherwise
0 if successful, -1 otherwise
the player.
Start a play operation. The player must have been open previously with
[linphone_player_open()]
.
0 if successful, -1 otherwise
Position of the playback in milliseconds
the player
Get the position of the playback
Position of the playback in milliseconds
The duration in milliseconds
the player
Get the duration of the media
The duration in milliseconds
the state of the player within MSPlayerClosed, MSPlayerStarted, MSPlayerPaused.
the player.
Get the state of play operation.
the state of the player within MSPlayerClosed, MSPlayerStarted, MSPlayerPaused.
Player interface.
The created presence activity, NULL on error.
The
[LinphonePresenceActivityType]
to set for the activity.
An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
Creates a presence activity.
The created presence activity, NULL on error.
The
[LinphonePresenceActivity]
object with the increased reference count.
The
[LinphonePresenceActivity]
object for which the reference count is to be increased.
Increase the reference count of the
[LinphonePresenceActivity]
object.
The
[LinphonePresenceActivity]
object with the increased reference count.
A pointer a dynamically allocated string representing the given activity.
The returned string is to be freed by calling ms_free().
A pointer to the
[LinphonePresenceActivity]
object for which to get a string representation.
Gets the string representation of a presence activity.
A pointer a dynamically allocated string representing the given activity.
The returned string is to be freed by calling ms_free().
The
[LinphonePresenceActivity]
object if the reference count is still positive, NULL if the object has been destroyed.
The
[LinphonePresenceActivity]
object for which the reference count is to be decreased.
Decrease the reference count of the
[LinphonePresenceActivity]
object and destroy it if it reaches 0.
The
[LinphonePresenceActivity]
object if the reference count is still positive, NULL if the object has been destroyed.
A pointer to the description string of the presence activity, or NULL if no description is specified.
A pointer to the
[LinphonePresenceActivity]
for which to get the description.
Gets the description of a presence activity.
A pointer to the description string of the presence activity, or NULL if no description is specified.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceActivity]
object for which to set the description.
An additional description of the activity. Can be NULL if no additional description is to be added.
Sets the description of a presence activity.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceActivityType]
of the activity.
A pointer to the
[LinphonePresenceActivity]
for which to get the type.
Gets the activity type of a presence activity.
The
[LinphonePresenceActivityType]
of the activity.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceActivity]
for which to set for the activity type.
The activity type to set for the activity.
Sets the type of activity of a presence activity.
0 if successful, a value < 0 in case of error.
A pointer to the user data.
The
[LinphonePresenceActivity]
object for which to get the user data.
Gets the user data of a
[LinphonePresenceActivity]
object.
A pointer to the user data.
The
[LinphonePresenceActivity]
object for which to set the user data.
A pointer to the user data to set.
Sets the user data of a
[LinphonePresenceActivity]
object.
Presence activity type holding information about a presence activity.
The created presence model, NULL on error.
Creates a default presence model.
The created presence model, NULL on error.
linphone_presence_model_new_with_activity
linphone_presence_model_new_with_activity_and_note
The created presence model, or NULL if an error occured.
The activity to set for the created presence model.
An additional description of the activity (mainly useful for the 'other' activity). Set it to NULL to not add a description.
Creates a presence model specifying an activity.
The created presence model, or NULL if an error occured.
linphone_presence_model_new
linphone_presence_model_new_with_activity_and_note
The created presence model, or NULL if an error occured.
The activity to set for the created presence model.
An additional description of the activity (mainly useful for the 'other' activity). Set it to NULL to not add a description.
An additional note giving additional information about the contact presence.
The language the note is written in. It can be set to NULL in order to not specify the language of the note.
Creates a presence model specifying an activity and adding a note.
The created presence model, or NULL if an error occured.
linphone_presence_model_new_with_activity
linphone_presence_model_new_with_activity_and_note
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceModel]
object for which to add an activity.
The
[LinphonePresenceActivity]
object to add to the model.
Adds an activity to a presence model.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
Only one note for each language can be set, so e.g. setting a note for the 'fr' language if there is only one will replace the existing one.
The
[LinphonePresenceModel]
object to add a note to.
The note to be added to the presence model.
The language of the note to be added. Can be NULL if no language is to be specified for the note.
Adds a note to a presence model.
0 if successful, a value < 0 in case of error.
Only one note for each language can be set, so e.g. setting a note for the 'fr' language if there is only one will replace the existing one.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceModel]
object for which to add a person.
The
[LinphonePresencePerson]
object to add to the model.
Adds a person to a presence model.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceModel]
object for which to add a service.
The
[LinphonePresenceService]
object to add to the model.
Adds a service to a presence model.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceModel]
object for which to clear the activities.
Clears the activities of a presence model.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceModel]
for which to clear notes.
Clears all the notes of a presence model.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceModel]
object for which to clear the persons.
Clears the persons of a presence model.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceModel]
object for which to clear the services.
Clears the services of a presence model.
0 if successful, a value < 0 in case of error.
A pointer to a
[LinphonePresenceNote]
object if successful, NULL otherwise.
The
[LinphonePresenceModel]
object to get the note from.
The language of the note to get. Can be NULL to get a note that has no language specified or to get the first note whatever language it is written into.
Gets the first note of a presence model (there is usually only one).
A pointer to a
[LinphonePresenceNote]
object if successful, NULL otherwise.
A pointer to a
[LinphonePresenceActivity]
object if successful, NULL otherwise.
The
[LinphonePresenceModel]
object to get the activity from.
The index of the activity to get (the first activity having the index 0).
Gets the nth activity of a presence model.
A pointer to a
[LinphonePresenceActivity]
object if successful, NULL otherwise.
A pointer to a
[LinphonePresencePerson]
object if successful, NULL otherwise.
The
[LinphonePresenceModel]
object to get the person from.
The index of the person to get (the first person having the index 0).
Gets the nth person of a presence model.
A pointer to a
[LinphonePresencePerson]
object if successful, NULL otherwise.
A pointer to a
[LinphonePresenceService]
object if successful, NULL otherwise.
The
[LinphonePresenceModel]
object to get the service from.
The index of the service to get (the first service having the index 0).
Gets the nth service of a presence model.
A pointer to a
[LinphonePresenceService]
object if successful, NULL otherwise.
The
[LinphonePresenceModel]
object with the increased reference count.
The
[LinphonePresenceModel]
object for which the reference count is to be increased.
Increase the reference count of the
[LinphonePresenceModel]
object.
The
[LinphonePresenceModel]
object with the increased reference count.
0 if successful, a value < 0 in case of error.
WARNING: This function will modify the basic status of the model according to the activity being set. If you don't want the basic status to be modified automatically, you can use the combination of
The
[LinphonePresenceModel]
object for which to set the activity.
The
[LinphonePresenceActivityType]
to set for the model.
An additional description of the activity to set for the model. Can be NULL if no additional description is to be added.
Sets the activity of a presence model (limits to only one activity).
0 if successful, a value < 0 in case of error.
WARNING: This function will modify the basic status of the model according to the activity being set. If you don't want the basic status to be modified automatically, you can use the combination of
[linphone_presence_model_set_basic_status()]
,
[linphone_presence_model_clear_activities()]
and
[linphone_presence_model_add_activity()]
.
The
[LinphonePresenceModel]
object if the reference count is still positive, NULL if the object has been destroyed.
The
[LinphonePresenceModel]
object for which the reference count is to be decreased.
Decrease the reference count of the
[LinphonePresenceModel]
object and destroy it if it reaches 0.
The
[LinphonePresenceModel]
object if the reference count is still positive, NULL if the object has been destroyed.
A
[LinphonePresenceActivity]
object if successful, NULL otherwise.
The
[LinphonePresenceModel]
object to get the activity from.
Gets the first activity of a presence model (there is usually only one).
A
[LinphonePresenceActivity]
object if successful, NULL otherwise.
The
[LinphonePresenceBasicStatus]
of the
[LinphonePresenceModel]
object given as parameter.
The
[LinphonePresenceModel]
object to get the basic status from.
Gets the basic status of a presence model.
The
[LinphonePresenceBasicStatus]
of the
[LinphonePresenceModel]
object given as parameter.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceModel]
object for which to set the basic status.
The
[LinphonePresenceBasicStatus]
to set for the
[LinphonePresenceModel]
object.
Sets the basic status of a presence model.
0 if successful, a value < 0 in case of error.
A pointer to a dynamically allocated string containing the contact, or NULL if no contact is found.
The returned string is to be freed by calling ms_free().
The
[LinphonePresenceModel]
object to get the contact from.
Gets the contact of a presence model.
A pointer to a dynamically allocated string containing the contact, or NULL if no contact is found.
The returned string is to be freed by calling ms_free().
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceModel]
object for which to set the contact.
The contact string to set.
Sets the contact of a presence model.
0 if successful, a value < 0 in case of error.
The number of activities included in the
[LinphonePresenceModel]
object.
The
[LinphonePresenceModel]
object to get the number of activities from.
Gets the number of activities included in the presence model.
The number of activities included in the
[LinphonePresenceModel]
object.
The number of persons included in the
[LinphonePresenceModel]
object.
The
[LinphonePresenceModel]
object to get the number of persons from.
Gets the number of persons included in the presence model.
The number of persons included in the
[LinphonePresenceModel]
object.
The number of services included in the
[LinphonePresenceModel]
object.
The
[LinphonePresenceModel]
object to get the number of services from.
Gets the number of services included in the presence model.
The number of services included in the
[LinphonePresenceModel]
object.
A pointer to a const LinphoneAddress, or NULL if no contact is found.
The
[LinphonePresenceModel]
object to get the contact from.
Gets the presentity of a presence model.
A pointer to a const LinphoneAddress, or NULL if no contact is found.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceModel]
object for which to set the contact.
The presentity address to set (presentity is copied).
Sets the presentity of a presence model.
0 if successful, a value < 0 in case of error.
The timestamp of the
[LinphonePresenceModel]
object or -1 on error.
The
[LinphonePresenceModel]
object to get the timestamp from.
Gets the timestamp of a presence model.
The timestamp of the
[LinphonePresenceModel]
object or -1 on error.
A pointer to the user data.
The
[LinphonePresenceModel]
object for which to get the user data.
Gets the user data of a
[LinphonePresenceModel]
object.
A pointer to the user data.
The
[LinphonePresenceModel]
object for which to set the user data.
A pointer to the user data to set.
Sets the user data of a
[LinphonePresenceModel]
object.
Presence model type holding information about the presence of a person.
The created presence note, NULL on error.
The content of the note to be created.
The language of the note to be created. Can be NULL if no language is to be specified for the note.
Creates a presence note.
The created presence note, NULL on error.
The
[LinphonePresenceNote]
object with the increased reference count.
The
[LinphonePresenceNote]
object for which the reference count is to be increased.
Increase the reference count of the
[LinphonePresenceNote]
object.
The
[LinphonePresenceNote]
object with the increased reference count.
The
[LinphonePresenceNote]
object if the reference count is still positive, NULL if the object has been destroyed.
The
[LinphonePresenceNote]
object for which the reference count is to be decreased.
Decrease the reference count of the
[LinphonePresenceNote]
object and destroy it if it reaches 0.
The
[LinphonePresenceNote]
object if the reference count is still positive, NULL if the object has been destroyed.
A pointer to the content of the presence note.
A pointer to the
[LinphonePresenceNote]
for which to get the content.
Gets the content of a presence note.
A pointer to the content of the presence note.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceNote]
object for which to set the content.
The content of the note.
Sets the content of a presence note.
0 if successful, a value < 0 in case of error.
A pointer to the language string of the presence note, or NULL if no language is specified.
A pointer to the
[LinphonePresenceNote]
for which to get the language.
Gets the language of a presence note.
A pointer to the language string of the presence note, or NULL if no language is specified.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceNote]
object for which to set the language.
The language of the note.
Sets the language of a presence note.
0 if successful, a value < 0 in case of error.
A pointer to the user data.
The
[LinphonePresenceNote]
object for which to get the user data.
Gets the user data of a
[LinphonePresenceNote]
object.
A pointer to the user data.
The
[LinphonePresenceNote]
object for which to set the user data.
A pointer to the user data to set.
Sets the user data of a
[LinphonePresenceNote]
object.
Presence note type holding information about a presence note.
The created presence person, NULL on error.
The id of the presence person to be created. Can be NULL to generate it automatically.
Creates a presence person.
The created presence person, NULL on error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresencePerson]
object for which to add an activities note.
The
[LinphonePresenceNote]
object to add to the person.
Adds an activities note to a presence person.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresencePerson]
object for which to add an activity.
The
[LinphonePresenceActivity]
object to add to the person.
Adds an activity to a presence person.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresencePerson]
object for which to add a note.
The
[LinphonePresenceNote]
object to add to the person.
Adds a note to a presence person.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresencePerson]
object for which to clear the activities.
Clears the activities of a presence person.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresencePerson]
object for which to clear the activities notes.
Clears the activities notes of a presence person.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresencePerson]
object for which to clear the notes.
Clears the notes of a presence person.
0 if successful, a value < 0 in case of error.
A pointer to a
[LinphonePresenceNote]
object if successful, NULL otherwise.
The
[LinphonePresencePerson]
object to get the activities note from.
The index of the activities note to get (the first note having the index 0).
Gets the nth activities note of a presence person.
A pointer to a
[LinphonePresenceNote]
object if successful, NULL otherwise.
A pointer to a
[LinphonePresenceActivity]
object if successful, NULL otherwise.
The
[LinphonePresencePerson]
object to get the activity from.
The index of the activity to get (the first activity having the index 0).
Gets the nth activity of a presence person.
A pointer to a
[LinphonePresenceActivity]
object if successful, NULL otherwise.
A pointer to a
[LinphonePresenceNote]
object if successful, NULL otherwise.
The
[LinphonePresencePerson]
object to get the note from.
The index of the note to get (the first note having the index 0).
Gets the nth note of a presence person.
A pointer to a
[LinphonePresenceNote]
object if successful, NULL otherwise.
The
[LinphonePresencePerson]
object with the increased reference count.
The
[LinphonePresencePerson]
object for which the reference count is to be increased.
Increase the reference count of the
[LinphonePresencePerson]
object.
The
[LinphonePresencePerson]
object with the increased reference count.
The
[LinphonePresencePerson]
object if the reference count is still positive, NULL if the object has been destroyed.
The
[LinphonePresencePerson]
object for which the reference count is to be decreased.
Decrease the reference count of the
[LinphonePresencePerson]
object and destroy it if it reaches 0.
The
[LinphonePresencePerson]
object if the reference count is still positive, NULL if the object has been destroyed.
A pointer to a dynamically allocated string containing the id, or NULL in case of error.
The returned string is to be freed by calling ms_free().
The
[LinphonePresencePerson]
object to get the id from.
Gets the id of a presence person.
A pointer to a dynamically allocated string containing the id, or NULL in case of error.
The returned string is to be freed by calling ms_free().
0 if successful, a value < 0 in case of error.
The
[LinphonePresencePerson]
object for which to set the id.
The id string to set. Can be NULL to generate it automatically.
Sets the id of a presence person.
0 if successful, a value < 0 in case of error.
The number of activities included in the
[LinphonePresencePerson]
object.
The
[LinphonePresencePerson]
object to get the number of activities from.
Gets the number of activities included in the presence person.
The number of activities included in the
[LinphonePresencePerson]
object.
The number of activities notes included in the
[LinphonePresencePerson]
object.
The
[LinphonePresencePerson]
object to get the number of activities notes from.
Gets the number of activities notes included in the presence person.
The number of activities notes included in the
[LinphonePresencePerson]
object.
The number of notes included in the
[LinphonePresencePerson]
object.
The
[LinphonePresencePerson]
object to get the number of notes from.
Gets the number of notes included in the presence person.
The number of notes included in the
[LinphonePresencePerson]
object.
A pointer to the user data.
The
[LinphonePresencePerson]
object for which to get the user data.
Gets the user data of a
[LinphonePresencePerson]
object.
A pointer to the user data.
The
[LinphonePresencePerson]
object for which to set the user data.
A pointer to the user data to set.
Sets the user data of a
[LinphonePresencePerson]
object.
Presence person holding information about a presence person.
The created presence service, NULL on error.
The created presence service has the basic status 'closed'.
The id of the presence service to be created. Can be NULL to generate it automatically.
The
[LinphonePresenceBasicStatus]
to set for the
[LinphonePresenceService]
object.
The contact string to set.
Creates a presence service.
The created presence service, NULL on error.
The created presence service has the basic status 'closed'.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceService]
object for which to add a note.
The
[LinphonePresenceNote]
object to add to the service.
Adds a note to a presence service.
0 if successful, a value < 0 in case of error.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceService]
object for which to clear the notes.
Clears the notes of a presence service.
0 if successful, a value < 0 in case of error.
A pointer to a
[LinphonePresenceNote]
object if successful, NULL otherwise.
The
[LinphonePresenceService]
object to get the note from.
The index of the note to get (the first note having the index 0).
Gets the nth note of a presence service.
A pointer to a
[LinphonePresenceNote]
object if successful, NULL otherwise.
The
[LinphonePresenceService]
object with the increased reference count.
The
[LinphonePresenceService]
object for which the reference count is to be increased.
Increase the reference count of the
[LinphonePresenceService]
object.
The
[LinphonePresenceService]
object with the increased reference count.
The
[LinphonePresenceService]
object if the reference count is still positive, NULL if the object has been destroyed.
The
[LinphonePresenceService]
object for which the reference count is to be decreased.
Decrease the reference count of the
[LinphonePresenceService]
object and destroy it if it reaches 0.
The
[LinphonePresenceService]
object if the reference count is still positive, NULL if the object has been destroyed.
The
[LinphonePresenceBasicStatus]
of the
[LinphonePresenceService]
object given as parameter.
The
[LinphonePresenceService]
object to get the basic status from.
Gets the basic status of a presence service.
The
[LinphonePresenceBasicStatus]
of the
[LinphonePresenceService]
object given as parameter.
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceService]
object for which to set the basic status.
The
[LinphonePresenceBasicStatus]
to set for the
[LinphonePresenceService]
object.
Sets the basic status of a presence service.
0 if successful, a value < 0 in case of error.
A pointer to a dynamically allocated string containing the contact, or NULL if no contact is found.
The returned string is to be freed by calling ms_free().
The
[LinphonePresenceService]
object to get the contact from.
Gets the contact of a presence service.
A pointer to a dynamically allocated string containing the contact, or NULL if no contact is found.
The returned string is to be freed by calling ms_free().
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceService]
object for which to set the contact.
The contact string to set.
Sets the contact of a presence service.
0 if successful, a value < 0 in case of error.
A pointer to a dynamically allocated string containing the id, or NULL in case of error.
The returned string is to be freed by calling ms_free().
The
[LinphonePresenceService]
object to get the id from.
Gets the id of a presence service.
A pointer to a dynamically allocated string containing the id, or NULL in case of error.
The returned string is to be freed by calling ms_free().
0 if successful, a value < 0 in case of error.
The
[LinphonePresenceService]
object for which to set the id.
The id string to set. Can be NULL to generate it automatically.
Sets the id of a presence service.
0 if successful, a value < 0 in case of error.
The number of notes included in the
[LinphonePresenceService]
object.
The
[LinphonePresenceService]
object to get the number of notes from.
Gets the number of notes included in the presence service.
The number of notes included in the
[LinphonePresenceService]
object.
A pointer to the user data.
The
[LinphonePresenceService]
object for which to get the user data.
Gets the user data of a
[LinphonePresenceService]
object.
A pointer to the user data.
The
[LinphonePresenceService]
object for which to set the user data.
A pointer to the user data to set.
Sets the user data of a
[LinphonePresenceService]
object.
Presence service type holding information about a presence service.
Creates an empty proxy config.
Destroys a proxy config.
: LinphoneProxyConfig that have been removed from LinphoneCore with
[linphone_core_remove_proxy_config()]
must not be freed.
Commits modification made to the proxy configuration.
Starts editing a proxy configuration.
Because proxy configuration must be consistent, applications MUST call
[linphone_proxy_config_edit()]
before doing any attempts to modify proxy configuration (such as identity, proxy address and so on). Once the modifications are done, then the application must call
[linphone_proxy_config_done()]
to commit the changes.
a
[LinphoneAuthInfo]
matching proxy config criteria if possible, NULL if nothing can be found.
[LinphoneProxyConfig]
object.
Find authentication info matching proxy config, if any, similarly to linphone_core_find_auth_info.
a
[LinphoneAuthInfo]
matching proxy config criteria if possible, NULL if nothing can be found.
the value of the queried header.
[LinphoneProxyConfig]
object.
the header name for which to fetch corresponding value
Obtain the value of a header sent by the server in last answer to REGISTER.
the value of the queried header.
TRUE if input is a phone number, FALSE otherwise.
[LinphoneProxyConfig]
argument, unused yet but may contain useful data. Can be NULL.
string to parse.
Detect if the given input is a phone number or not.
TRUE if input is a phone number, FALSE otherwise.
TRUE if a phone number was recognized, FALSE otherwise.
[LinphoneProxyConfig]
object containing country code and/or escape symbol. If NULL passed, will use default configuration.
the string to parse
the newly normalized number
the size of the normalized number
result
See linphone_proxy_config_normalize_phone_number
TRUE if a phone number was recognized, FALSE otherwise.
NULL if input is an invalid phone number, normalized phone number from username input otherwise.
[LinphoneProxyConfig]
object containing country code and/or escape symbol. If NULL passed, will use default configuration.
the string to parse
Normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222 or +33888444222 depending on the
[LinphoneProxyConfig]
object. This function will always generate a normalized username if input is a phone number.
NULL if input is an invalid phone number, normalized phone number from username input otherwise.
NULL if invalid input, normalized sip address otherwise.
[LinphoneProxyConfig]
object containing country code, escape symbol and/or domain name. Can be NULL if domain is already provided.
the string to parse
Normalize a human readable sip uri into a fully qualified LinphoneAddress. A sip address should look like DisplayName <sip:username@domain:port> . Basically this function performs the following tasks
if a phone number is entered, prepend country prefix and eventually escape the '+' by 00 of the proxy config.
if no domain part is supplied, append the domain name of the proxy config. Returns NULL if no proxy is provided at this point.
if no sip: is present, prepend it.
The result is a syntactically correct SIP address.
NULL if invalid input, normalized sip address otherwise.
[LinphoneProxyConfig]
object.
Prevent a proxy config from refreshing its registration. This is useful to let registrations to expire naturally (or) when the application wants to keep control on when refreshes are sent. However, linphone_core_set_network_reachable(lc,TRUE) will always request the proxy configs to refresh their registrations. The refreshing operations can be resumed with
[linphone_proxy_config_refresh_register()]
.
The same proxy config.
[LinphoneProxyConfig]
object.
Acquire a reference to the proxy config.
The same proxy config.
Refresh a proxy registration. This is useful if for example you resuming from suspend, thus IP address may have changed.
[LinphoneProxyConfig]
object.
the header name
the header's value
Set the value of a custom header sent to the server in REGISTERs request.
[LinphoneProxyConfig]
object.
Release reference to the proxy config.
True if AVPF/SAVPF is enabled, false otherwise.
[LinphoneProxyConfig]
object.
Indicates whether AVPF/SAVPF is being used for calls using this proxy config.
True if AVPF/SAVPF is enabled, false otherwise.
[LinphoneProxyConfig]
object.
True to enable AVPF/SAVF, false to disable it.
Indicates whether AVPF/SAVPF must be used for calls using this proxy config.
the enablement mode, which can be LinphoneAVPFDefault (use LinphoneCore's mode), LinphoneAVPFEnabled (avpf is enabled), or LinphoneAVPFDisabled (disabled).
[LinphoneProxyConfig]
object.
Get enablement status of RTCP feedback (also known as AVPF profile).
the enablement mode, which can be LinphoneAVPFDefault (use LinphoneCore's mode), LinphoneAVPFEnabled (avpf is enabled), or LinphoneAVPFDisabled (disabled).
[LinphoneProxyConfig]
object.
the enablement mode, which can be LinphoneAVPFDefault (use LinphoneCore's mode), LinphoneAVPFEnabled (avpf is enabled), or LinphoneAVPFDisabled (disabled).
Enable the use of RTCP feedback (also known as AVPF profile).
The interval in seconds.
[LinphoneProxyConfig]
object.
Get the interval between regular RTCP reports when using AVPF/SAVPF.
The interval in seconds.
[LinphoneProxyConfig]
object.
The interval in seconds (between 0 and 5 seconds).
Set the interval between regular RTCP reports when using AVPF/SAVPF.
previously set contact parameters.
previously set contact parameters.
[LinphoneProxyConfig]
object.
a string contaning the additional parameters in text form, like "myparam=something;myparam2=something_else"
Set optional contact parameters that will be added to the contact information sent in the registration.
joe@15.128.128.93
:50421>;apple-push-id=43143-DFE23F-2323-FA2232.
previously set contact URI parameters.
previously set contact URI parameters.
[LinphoneProxyConfig]
object.
a string containing the additional parameters in text form, like "myparam=something;myparam2=something_else"
Set optional contact parameters that will be added to the contact information sent in the registration, inside the URI.
joe@15.128.128.93
:50421;apple-push-id=43143-DFE23F-2323-FA2232>.
The
[LinphoneCore]
object to which is associated the
[LinphoneProxyConfig]
.
[LinphoneProxyConfig]
object.
Get the
[LinphoneCore]
object to which is associated the
[LinphoneProxyConfig]
.
The
[LinphoneCore]
object to which is associated the
[LinphoneProxyConfig]
.
whether liblinphone should replace "+" by "00" in dialed numbers (passed to
[linphone_core_invite]
).
whether liblinphone should replace "+" by "00" in dialed numbers (passed to
[linphone_core_invite]
).
Sets whether liblinphone should replace "+" by international calling prefix in dialed numbers (passed to
[linphone_core_invite]
).
dialing prefix.
dialing prefix.
Sets a dialing prefix to be automatically prepended when inviting a number with
[linphone_core_invite()]
; This dialing prefix shall usually be the country code of the country where the user is living, without "+".
The domain name of the proxy config.
[LinphoneProxyConfig]
object.
Get the domain name of the given proxy config.
The domain name of the proxy config.
The reason why registration failed for this proxy config.
[LinphoneProxyConfig]
object.
Get the reason why registration failed when the proxy config state is LinphoneRegistrationFailed.
The reason why registration failed for this proxy config.
The details why registration failed for this proxy config.
[LinphoneProxyConfig]
object.
Get detailed information why registration failed when the proxy config state is LinphoneRegistrationFailed.
The details why registration failed for this proxy config.
the duration of registration.
the duration of registration.
Sets the registration expiration time in seconds.
URL of the file server like
https://file.linphone.org/upload.php
[LinphoneProxyConfig]
object.
Get the http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml
URL of the file server like
https://file.linphone.org/upload.php
That function isn't implemented yet.
[LinphoneProxyConfig]
object.
URL of the file server like
https://file.linphone.org/upload.php
Set the http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml
That function isn't implemented yet.
the SIP identity that belongs to this proxy configuration.
the SIP identity that belongs to this proxy configuration.
Sets the user identity as a SIP address.
This identity is normally formed with display name, username and domain, such as: Alice <sip:
alice@example.net
> The REGISTER messages will have from and to set to this identity.
LinphoneNatPolicy object in use.
[LinphoneProxyConfig]
object
Get The policy that is used to pass through NATs/firewalls when using this proxy config. If it is set to NULL, the default NAT policy from the core will be used instead.
LinphoneNatPolicy object in use.
linphone_core_get_nat_policy()
[LinphoneProxyConfig]
object
LinphoneNatPolicy object
Set the policy to use to pass through NATs/firewalls when using this proxy config. If it is set to NULL, the default NAT policy from the core will be used instead.
linphone_core_set_nat_policy()
Privacy mode
[LinphoneProxyConfig]
object.
Get default privacy policy for all calls routed through this proxy.
Privacy mode
[LinphoneProxyConfig]
object.
LinphonePrivacy to configure privacy
Set default privacy policy for all calls routed through this proxy.
TRUE if PUBLISH request is enabled for this proxy.
TRUE if PUBLISH request is enabled for this proxy.
[LinphoneProxyConfig]
object.
if true, publish will be engaged
Indicates either or not, PUBLISH must be issued for this
[LinphoneProxyConfig]
.
In case this
[LinphoneProxyConfig]
has been added to
[LinphoneCore]
, follows the
[linphone_proxy_config_edit()]
rule.
expires in second
[LinphoneProxyConfig]
object.
get the publish expiration time in second. Default value is the registration expiration value.
expires in second
[LinphoneProxyConfig]
object.
in second
Set the publish expiration time in second.
The SIP address of the collector end-point.
[LinphoneProxyConfig]
object.
Get the route of the collector end-point when using quality reporting. This SIP address should be used on server-side to process packets directly before discarding packets. Collector address should be a non existing account and will not receive any messages. If NULL, reports will be send to the proxy domain.
The SIP address of the collector end-point.
[LinphoneProxyConfig]
object.
route of the collector end-point, if NULL PUBLISH will be sent to the proxy domain.
Set the route of the collector end-point when using quality reporting. This SIP address should be used on server-side to process packets directly before discarding packets. Collector address should be a non existing account and will not receive any messages. If NULL, reports will be send to the proxy domain.
True if quality repotring is enabled, false otherwise.
[LinphoneProxyConfig]
object.
Indicates whether quality statistics during call should be stored and sent to a collector according to RFC 6035.
True if quality repotring is enabled, false otherwise.
[LinphoneProxyConfig]
object.
True to sotre quality statistics and sent them to the collector, false to disable it.
Indicates whether quality statistics during call should be stored and sent to a collector according to RFC 6035.
The interval in seconds, 0 means interval reports are disabled.
[LinphoneProxyConfig]
object.
Get the interval between interval reports when using quality reporting.
The interval in seconds, 0 means interval reports are disabled.
[LinphoneProxyConfig]
object.
The interval in seconds, 0 means interval reports are disabled.
Set the interval between 2 interval reports sending when using quality reporting. If call exceed interval size, an interval report will be sent to the collector. On call termination, a session report will be sent for the remaining period. Value must be 0 (disabled) or positive.
The realm of the proxy config.
[LinphoneProxyConfig]
object.
Get the realm of the given proxy config.
The realm of the proxy config.
The realm of the proxy config.
[LinphoneProxyConfig]
object.
New realm value.
Set the realm of the given proxy config.
The realm of the proxy config.
The reference key string that has been associated to the proxy config, or NULL if none has been associated.
[LinphoneProxyConfig]
object.
Get the persistent reference key associated to the proxy config.
The reference key can be for example an id to an external database. It is stored in the config file, thus can survive to process exits/restarts.
The reference key string that has been associated to the proxy config, or NULL if none has been associated.
[LinphoneProxyConfig]
object.
The reference key string to associate to the proxy config.
Associate a persistent reference key to the proxy config.
The reference key can be for example an id to an external database. It is stored in the config file, thus can survive to process exits/restarts.
TRUE if registration to the proxy is enabled.
TRUE if registration to the proxy is enabled.
[LinphoneProxyConfig]
object.
if true, registration will be engaged
Indicates either or not, REGISTRATION must be issued for this
[LinphoneProxyConfig]
.
In case this
[LinphoneProxyConfig]
has been added to
[LinphoneCore]
, follows the
[linphone_proxy_config_edit()]
rule.
a boolean indicating that the user is sucessfully registered on the proxy.
a boolean indicating that the user is sucessfully registered on the proxy.
the route set for this proxy configuration.
the route set for this proxy configuration.
-1 if route is invalid, 0 otherwise.
Sets a SIP route. When a route is set, all outgoing calls will go to the route's destination if this proxy is the default one (see
[linphone_core_set_default_proxy()]
).
-1 if route is invalid, 0 otherwise.
the proxy's SIP address.
the proxy's SIP address.
Sets the proxy address
Examples of valid sip proxy address are:
IP address: sip:87.98.157.38
IP address with port: sip:87.98.157.38:5062
hostnames : sip:sip.example.net
The registration state of the proxy config.
[LinphoneProxyConfig]
object.
Get the registration state of the given proxy config.
The registration state of the proxy config.
The transport as a string (I.E udp, tcp, tls, dtls)
[LinphoneProxyConfig]
object.
Get the transport from either service route, route or addr.
The transport as a string (I.E udp, tcp, tls, dtls)
The user pointer associated with the proxy config.
[LinphoneProxyConfig]
object.
Retrieve the user pointer associated with the proxy config.
The user pointer associated with the proxy config.
[LinphoneProxyConfig]
object.
The user pointer to associate with the proxy config.
Assign a user pointer to the proxy config.
The LinphoneProxyConfig object represents a proxy configuration to be used by the LinphoneCore object. Its fields must not be used directly in favour of the accessors methods. Once created and filled properly the LinphoneProxyConfig can be given to LinphoneCore with
[linphone_core_add_proxy_config()]
. This will automatically triggers the registration, if enabled.
The proxy configuration are persistent to restarts because they are saved in the configuration file. As a consequence, after
[linphone_core_new()]
there might already be a list of configured proxy that can be examined with
[linphone_core_get_proxy_config_list()]
.
The default proxy (see
[linphone_core_set_default_proxy()]
) is the one of the list that is used by default for calls.
An LinphoneTunnelMode enum. If the passed string is NULL or does not match with any mode, the LinphoneTunnelModeDisable is returned.
String to convert
Convert a string into LinphoneTunnelMode enum
An LinphoneTunnelMode enum. If the passed string is NULL or does not match with any mode, the LinphoneTunnelModeDisable is returned.
"disable", "enable" or "auto"
Enum to convert
Convert a tunnel mode enum into string
"disable", "enable" or "auto"
LinphoneTunnel object
LinphoneTunnelConfig object
Add a tunnel server configuration.
object In auto detect mode, the tunnel manager try to establish a real time rtp communication with the tunnel server on specified port.
In case of success, the tunnel is automatically turned off. Otherwise, if no udp communication is feasible, tunnel mode is turned on.
Call this method each time to run the auto detection algorithm
Start tunnel need detection.
LinphoneTunnel object
Remove all tunnel server addresses previously entered with
[linphone_tunnel_add_server()]
A boolean value telling if the tunnel is connected
LinphoneTunnel object
Check whether the tunnel is connected
A boolean value telling if the tunnel is connected
object
If true enter in tunneled mode, if false exits from tunneled mode. The TunnelManager takes care of refreshing SIP registration when switching on or off the tunneled mode.
Sets whether tunneling of SIP and RTP is required.
Returns a boolean indicating whether tunneled operation is enabled.
Tunnel object
Check whether tunnel is enabled
Returns a boolean indicating whether tunneled operation is enabled.
LinphoneTunnel object
http proxy host
http proxy port
Optional http proxy username if the proxy request authentication. Currently only basic authentication is supported. Use NULL if not needed.
Optional http proxy password. Use NULL if not needed.
Retrieve optional http proxy configuration previously set with
[linphone_tunnel_set_http_proxy()]
.
LinphoneTunnel object
Force reconnection to the tunnel server. This method is useful when the device switches from wifi to Edge/3G or vice versa. In most cases the tunnel client socket won't be notified promptly that its connection is now zombie, so it is recommended to call this method that will cause the lost connection to be closed and new connection to be issued.
LinphoneTunnel object
LinphoneTunnelConfig object
Remove a tunnel server configuration.
LinphoneTunnel object
http proxy host
http proxy port
Optional http proxy username if the proxy request authentication. Currently only basic authentication is supported. Use NULL if not needed.
Optional http proxy password. Use NULL if not needed.
Set an optional http proxy to go through when connecting to tunnel server.
LinphoneTunnel object
User name
Password
Set authentication info for the http proxy
TRUE if tunnel is in use, FALSE otherwise.
the tunnel
Returns whether the tunnel is activated. If mode is set to auto, this gives indication whether the automatic detection determined that tunnel was necessary or not.
TRUE if tunnel is in use, FALSE otherwise.
TRUE if auto detection is enabled, FALSE otherwise.
LinphoneTunnel object.
Tell whether tunnel auto detection is enabled.
TRUE if auto detection is enabled, FALSE otherwise.
The current LinphoneTunnelMode
LinphoneTunnel object
Get the tunnel mode
The current LinphoneTunnelMode
LinphoneTunnel object
The desired LinphoneTunnelMode
Set the tunnel mode. The tunnel mode can be 'enable', 'disable' or 'auto' If the mode is set to 'auto', the tunnel manager will try to established an RTP session with the tunnel server on the UdpMirrorPort. If the connection fail, the tunnel is automatically activated whereas the tunnel is automatically disabled if the connection succeed.
A list of
[LinphoneTunnelConfig]
objects.
LinphoneTunnelConfig
LinphoneTunnel object
Get added servers
A list of
[LinphoneTunnelConfig]
objects.
LinphoneTunnelConfig
A boolean value telling whether SIP packets shall pass through the tunnel
LinphoneTunnel object
Check whether tunnel is set to transport SIP packets
A boolean value telling whether SIP packets shall pass through the tunnel
LinphoneTunnel object
If true, SIP packets shall pass through the tunnel
Set whether SIP packets must be directly sent to a UA or pass through the tunnel
Linphone tunnel object.
Create a new tunnel configuration
LinphoneTunnelConfig object
Destroy a tunnel configuration
the same cfg object.
the LinphoneTunnelConfig object.
Increment the refcount of LinphoneTunnelConfig object.
the same cfg object.
the LinphoneTunnelConfig object.
Decrement the refcount of LinphoneTunnelConfig object.
The UDP packet round trip delay in ms.
LinphoneTunnelConfig object
Get the UDP packet round trip delay in ms for a tunnel configuration.
The UDP packet round trip delay in ms.
LinphoneTunnelConfig object
The UDP packet round trip delay in ms considered as acceptable (recommended value is 1000 ms).
Set the UDP packet round trip delay in ms for a tunnel configuration.
The tunnel server IP address or hostname
LinphoneTunnelConfig object
Get the IP address or hostname of the tunnel server.
The tunnel server IP address or hostname
LinphoneTunnelConfig object
The tunnel server IP address or hostname
Set the IP address or hostname of the tunnel server.
The TLS port of the tunnel server
LinphoneTunnelConfig object
Get the TLS port of the tunnel server.
The TLS port of the tunnel server
LinphoneTunnelConfig object
The tunnel server TLS port, recommended value is 443
Set tls port of server.
The remote port on the tunnel server side used to test UDP reachability
LinphoneTunnelConfig object
Get the remote port on the tunnel server side used to test UDP reachability. This is used when the mode is set auto, to detect whether the tunnel has to be enabled or not.
The remote port on the tunnel server side used to test UDP reachability
LinphoneTunnelConfig object
The remote port on the tunnel server side used to test UDP reachability, set to -1 to disable the feature
Set the remote port on the tunnel server side used to test UDP reachability. This is used when the mode is set auto, to detect whether the tunnel has to be enabled or not.
the user data
the tunnel config
Retrieve user data from the tunnel config
the user data
the tunnel config
the user data
Store a user data in the tunnel config object
Linphone tunnel aims is to bypass IP traffic blocking due to aggressive firewalls which typically only authorize TCP traffic with destination port 443.
Its principle is tunneling all SIP and/or RTP traffic through a single secure https connection up to a detunnelizer server.
This set of methods enhance LinphoneCore functionalities in order to provide an easy to use API to
provision tunnel servers IP addresses and ports. This functionality is an option not implemented under GPL. Availability can be check at runtime using function
[linphone_core_tunnel_available]
start/stop the tunneling service
perform auto-detection whether tunneling is required, based on a test of sending/receiving a flow of UDP packets.
It takes in charge automatically the SIP registration procedure when connecting or disconnecting to a tunnel server. No other action on LinphoneCore is required to enable full operation in tunnel mode.
Provision is done using object
[LinphoneTunnelConfig]
created by function
[linphone_tunnel_config_new()]
. Functions
[linphone_tunnel_config_set_host]
and
[linphone_tunnel_config_set_port]
allow to point to tunnel server IP/port. Once set, use function
[linphone_tunnel_add_server]
to provision a tunnel server.
Finally tunnel mode configuration is achieved by function
[linphone_tunnel_set_mode]
.
Tunnel connection status can be checked using function
[linphone_tunnel_connected]
.
Bellow pseudo code that can be use to configure, enable, check state and disable tunnel functionality:
LinphoneTunnel
*tunnel
=
linphone_core_get_tunnel(linphone_core);
LinphoneTunnelConfig
*config=linphone_tunnel_config_new();
//instantiate
tunnel
configuration
linphone_tunnel_config_set_host(config,
"tunnel.linphone.org");
//set
tunnel
server
host
address
linphone_tunnel_config_set_port(config,
443);
//set
tunnel
server
port
linphone_tunnel_add_server(tunnel,
config);
//provision
tunnel
config
linphone_tunnel_set_mode(tunnel,
LinphoneTunnelModeEnable);
//activate
the
tunnel
unconditional
while
(!linphone_tunnel_connected(tunnel))
{
//wait
for
tunnel
to
be
ready
linphone_core_iterate(linphone_core);
//schedule
core
main
loop
ms_sleep(100);
//wait
100ms
}
LinphoneCall
*call
=
linphone_core_invite(linphone_core,"sip:foo@example.org");
//place
an
outgoing
call
linphone_call_ref(call);
//acquire
a
reference
on
the
call
to
avoid
deletion
after
completion
//...
linphone_core_terminate_call(linphone_core,call);
while
(linphone_call_get_state(call)
!=
LinphoneCallReleased)
{
//wait
for
call
to
be
in
release
state
linphone_core_iterate(linphone_core);
//schedule
core
main
loop
ms_sleep(100);
//wait
100ms
}
linphone_tunnel_set_mode(tunnel,
LinphoneTunnelModeDisable);
//deactivate
tunnel
linphone_call_unref(call);
//release
reference
on
the
call
a new LinphoneVcard object
Creates a LinphoneVcard object that has a pointer to an empty vCard
a new LinphoneVcard object
the LinphoneVcard
the phone number to add
Adds a phone number in the vCard, using the TEL property
the LinphoneVcard
the SIP address to add
Adds a SIP address in the vCard, using the IMPP property
a const char * that represents the vCard
the LinphoneVcard
Returns the vCard4 representation of the LinphoneVcard.
a const char * that represents the vCard
the LinphoneVcard
the new SIP address
Edits the preferred SIP address in the vCard (or the first one), using the IMPP property
the LinphoneVcard to destroy
Deletes a LinphoneVcard object properly
TRUE if operation is successful, otherwise FALSE (for example if it already has an unique ID)
the LinphoneVcard
Generates a random unique id for the vCard. If is required to be able to synchronize the vCard with a CardDAV server
TRUE if operation is successful, otherwise FALSE (for example if it already has an unique ID)
Take a ref on a
[LinphoneVcard]
.
the LinphoneVcard
the phone number to remove
Removes a phone number in the vCard (if it exists), using the TEL property
the LinphoneVcard
the SIP address to remove
Removes a SIP address in the vCard (if it exists), using the IMPP property
Release a
[LinphoneVcard]
.
the eTag of the vCard in the CardDAV server, otherwise NULL
the LinphoneVcard
Gets the eTag of the vCard
the eTag of the vCard in the CardDAV server, otherwise NULL
the LinphoneVcard
the eTAG
Sets the eTAG of the vCard
the family name of the vCard, or NULL
the LinphoneVcard
Returns the family name in the N attribute of the vCard, or NULL if it isn't set yet.
the family name of the vCard, or NULL
the LinphoneVcard
the family name to set for the vCard
Sets the family name in the N attribute of the vCard.
the display name of the vCard, or NULL
the LinphoneVcard
Returns the FN attribute of the vCard, or NULL if it isn't set yet.
the display name of the vCard, or NULL
the LinphoneVcard
the display name to set for the vCard
Sets the FN attribute of the vCard (which is mandatory).
the given name of the vCard, or NULL
the LinphoneVcard
Returns the given name in the N attribute of the vCard, or NULL if it isn't set yet.
the given name of the vCard, or NULL
the LinphoneVcard
the given name to set for the vCard
Sets the given name in the N attribute of the vCard.
the Organization of the vCard or NULL
the LinphoneVcard
Gets the Organization of the vCard
the Organization of the vCard or NULL
the LinphoneVcard
the Organization
Fills the Organization field of the vCard
A list of const char * objects.
const char *
the LinphoneVcard
Returns the list of phone numbers (as string) in the vCard (all the TEL attributes) or NULL
A list of const char * objects.
const char *
A list of
[LinphoneAddress]
objects.
LinphoneAddress
the LinphoneVcard
Returns the list of SIP addresses (as LinphoneAddress) in the vCard (all the IMPP attributes that has an URI value starting by "sip:") or NULL
A list of
[LinphoneAddress]
objects.
LinphoneAddress
the UID of the vCard, otherwise NULL
the LinphoneVcard
Gets the UID of the vCard
the UID of the vCard, otherwise NULL
the LinphoneVcard
the unique id
Sets the unique ID of the vCard
the URL of the vCard in the CardDAV server, otherwise NULL
the LinphoneVcard
Gets the URL of the vCard
the URL of the vCard in the CardDAV server, otherwise NULL
the LinphoneVcard
the URL
Sets the URL of the vCard
The LinphoneVcard object.
A new LinphoneXmlRpcRequest object.
The XML-RPC method to call.
The expected XML-RPC response type.
Create a new LinphoneXmlRpcRequest object.
A new LinphoneXmlRpcRequest object.
A new LinphoneXmlRpcRequest object.
The XML-RPC method to call.
The expected XML-RPC response type.
Create a new LinphoneXmlRpcRequest object giving the arguments to the method call.
A new LinphoneXmlRpcRequest object.
LinphoneXmlRpcRequest object.
The integer value of the added argument.
Add an integer argument to an XML-RPC request.
LinphoneXmlRpcRequest object.
The string value of the added argument.
Add a string argument to an XML-RPC request.
The same LinphoneXmlRpcRequest object.
LinphoneXmlRpcRequest object.
Acquire a reference to the XML-RPC request.
The same LinphoneXmlRpcRequest object.
LinphoneXmlRpcRequest object.
Release reference to the XML-RPC request.
The LinphoneXmlRpcRequestCbs object associated with the LinphoneXmlRpcRequest.
LinphoneXmlRpcRequest object
Get the LinphoneXmlRpcRequestCbs object associated with a LinphoneXmlRpcRequest.
The LinphoneXmlRpcRequestCbs object associated with the LinphoneXmlRpcRequest.
The string representation of the content of the XML-RPC request.
LinphoneXmlRpcRequest object.
Get the content of the XML-RPC request.
The string representation of the content of the XML-RPC request.
The integer response to the XML-RPC request.
LinphoneXmlRpcRequest object.
Get the response to an XML-RPC request sent with
[linphone_xml_rpc_session_send_request()]
and returning an integer response.
The integer response to the XML-RPC request.
The status of the XML-RPC request.
LinphoneXmlRpcRequest object.
Get the status of the XML-RPC request.
The status of the XML-RPC request.
The string response to the XML-RPC request.
LinphoneXmlRpcRequest object.
Get the response to an XML-RPC request sent with
[linphone_xml_rpc_session_send_request()]
and returning a string response.
The string response to the XML-RPC request.
The user pointer associated with the XML-RPC request.
LinphoneXmlRpcRequest object.
Retrieve the user pointer associated with the XML-RPC request.
The user pointer associated with the XML-RPC request.
LinphoneXmlRpcRequest object.
The user pointer to associate with the XML-RPC request.
Assign a user pointer to the XML-RPC request.
The LinphoneXmlRpcRequest object representing a XML-RPC request to be sent.
LinphoneXmlRpcRequest object
Callback used to notify the response to an XML-RPC request.
The same LinphoneXmlRpcRequestCbs object.
LinphoneXmlRpcRequestCbs object.
Acquire a reference to a LinphoneXmlRpcRequestCbs object.
The same LinphoneXmlRpcRequestCbs object.
LinphoneXmlRpcRequestCbs object.
Release a reference to a LinphoneXmlRpcRequestCbs object.
The current response callback.
LinphoneXmlRpcRequestCbs object.
Get the response callback.
The current response callback.
LinphoneXmlRpcRequestCbs object.
The response callback to be used.
Set the response callback.
The user pointer associated with the LinphoneXmlRpcRequestCbs object.
LinphoneXmlRpcRequestCbs object.
Retrieve the user pointer associated with a LinphoneXmlRpcRequestCbs object.
The user pointer associated with the LinphoneXmlRpcRequestCbs object.
LinphoneXmlRpcRequestCbs object.
The user pointer to associate with the LinphoneXmlRpcRequestCbs object.
Assign a user pointer to a LinphoneXmlRpcRequestCbs object.
An object to handle the callbacks for handling the LinphoneXmlRpcRequest operations.
A new LinphoneXmlRpcSession object.
The LinphoneCore object used to send the XML-RPC requests.
The URL of the XML-RPC server to send the XML-RPC requests to.
Create a new LinphoneXmlRpcSession object.
A new LinphoneXmlRpcSession object.
The same LinphoneXmlRpcSession object.
LinphoneXmlRpcSession object.
Acquire a reference to the XML-RPC session.
The same LinphoneXmlRpcSession object.
LinphoneXmlRpcSession object.
Stop and unref an XML rpc session. Pending requests will be aborted.
LinphoneXmlRpcSession object.
The LinphoneXmlRpcRequest to be sent.
Send an XML-RPC request.
LinphoneXmlRpcSession object.
Release reference to the XML-RPC session.
This will not stop pending xml-rpc requests. Use
[linphone_xml_rpc_session_release()]
instead if this is intended.
The user pointer associated with the XML-RPC session.
LinphoneXmlRpcSession object.
Retrieve the user pointer associated with the XML-RPC session.
The user pointer associated with the XML-RPC session.
LinphoneXmlRpcSession object.
The user pointer to associate with the XML-RPC session.
Assign a user pointer to the XML-RPC session.
The LinphoneXmlRpcSession object used to send XML-RPC requests and handle their responses.
Loads a dictionary into a section of the lpconfig. If the section doesn't exist it is created. Overwrites existing keys, creates non-existing keys.
a #LinphoneDictionary with all the keys from a section, or NULL if the section doesn't exist
Converts a config section into a dictionary.
a #LinphoneDictionary with all the keys from a section, or NULL if the section doesn't exist
Define old struct name for backward compatibility