mirror of
https://gitlab.linphone.org/BC/public/linphone-iphone.git
synced 2026-01-22 21:58:08 +00:00
89 lines
2.8 KiB
Text
89 lines
2.8 KiB
Text
/**
|
|
* @mainpage
|
|
*
|
|
* @see http://www.linphone.org
|
|
*
|
|
* @section what_is_it What is liblinphone
|
|
*
|
|
* Liblinphone is a high level library for bringing SIP video call functionnality
|
|
* into an application. It aims at making easy the integration of the SIP
|
|
* video calls into any applications. All variants of linphone are directly based
|
|
* on it:
|
|
* - linphone (gtk interface)
|
|
*
|
|
* - linphonec (console interface)
|
|
*
|
|
* Liblinphone is GPL (see COPYING file). Please understand the licencing details
|
|
* before using it!
|
|
*
|
|
* For any use of this library beyond the rights granted to you by the
|
|
* GPL license, please contact Belledonne Communications
|
|
* (contact@belledonne-communications.com)
|
|
*
|
|
*
|
|
**/
|
|
|
|
/**
|
|
* @page liblinphone_license COPYING
|
|
* @verbinclude COPYING
|
|
*/
|
|
|
|
/**
|
|
* @defgroup initializing Initializing liblinphone
|
|
**/
|
|
|
|
/**
|
|
* @defgroup call_control Placing and receiving calls
|
|
**/
|
|
|
|
/**
|
|
* @defgroup media_parameters Controlling media parameters
|
|
**/
|
|
|
|
/**
|
|
* @defgroup proxies Managing proxies
|
|
*User registration is control by #LinphoneProxyConfig settings.<br> Each #LinphoneProxyConfig object can be configured with Registration information like proxy address, user id, refresh period, etc
|
|
*<br> A created proxy config using linphone_proxy_config_new(void) once configured #LinphoneProxyConfig must be added to #LinphoneCore using function linphone_core_add_proxy_config().
|
|
*<br> It is recommanded to set a default proxy config using function linphone_core_set_default_proxy(). Once done, if proxy config has been configured with attribute enable register linphone_proxy_config_enable_register() , next call to linphone_core_iterate() triggers a SIP registration.
|
|
*<br> Registration status is reported by #LinphoneRegistrationStateCb.
|
|
*<br>
|
|
*<br> This pseudo code demonstrte basic registration operation
|
|
*<br>
|
|
*<br><b>Authentication</b>
|
|
*<br>Most of the time, registration requires \ref authentication "authentication" to succed. #LinphoneAuthInfo info must be either added to #LinphoneCore using function linphone_core_add_auth_info() before #LinphoneProxyConfig is added to Linphone core, or on demand from call back #AuthInfoRequested .
|
|
*<br>
|
|
*<br><b>Unregistration</b>
|
|
**/
|
|
|
|
/**
|
|
* @defgroup network_parameters Controlling network parameters (ports, mtu...)
|
|
**/
|
|
|
|
/**
|
|
* @defgroup authentication Managing authentication: userid and passwords
|
|
**/
|
|
|
|
/**
|
|
* @defgroup call_logs Managing call logs
|
|
**/
|
|
|
|
|
|
/**
|
|
* @defgroup linphone_address SIP address parser API.
|
|
* This api is useful for manipulating SIP addresses ('from' or 'to' headers).
|
|
**/
|
|
|
|
/**
|
|
* @defgroup misc Miscenalleous: logs, version strings, config storage
|
|
**/
|
|
|
|
/**
|
|
* @defgroup tutorial_liblinphone Tutorial: Placing calls with liblinphone
|
|
*
|
|
* The minimalist program below illustrates how to initialize liblinphone and place and outgoing call.
|
|
* @include helloworld.c
|
|
*
|
|
**/
|
|
|
|
|
|
|