doxygen.dox.in 2.82 KB
Newer Older
1 2 3
/**
 * @mainpage
 *
4
 * @see http://www.linphone.org
5 6 7 8 9 10 11
 *
 * @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:
smorlat's avatar
smorlat committed
12 13 14 15
 * - linphone (gtk interface)
 *
 * - linphonec (console interface)
 *
16 17 18 19 20 21 22
 * 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)
 * 
23 24
 *
**/
25 26 27 28 29 30

/**
 * @page liblinphone_license COPYING 
 * @verbinclude COPYING
 */

Simon Morlat's avatar
Simon Morlat committed
31
/**
Simon Morlat's avatar
Simon Morlat committed
32
 * @defgroup initializing Initializing liblinphone
33 34
**/

smorlat's avatar
smorlat committed
35
/**
Simon Morlat's avatar
Simon Morlat committed
36
 * @defgroup call_control Placing and receiving calls
smorlat's avatar
smorlat committed
37 38
**/

39 40 41 42 43
/**
 * @defgroup media_parameters Controlling media parameters
**/

/**
smorlat's avatar
smorlat committed
44
 * @defgroup proxies Managing proxies
jehan's avatar
jehan committed
45 46 47 48 49 50 51 52 53 54 55
 *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>
smorlat's avatar
smorlat committed
56 57
**/

smorlat's avatar
smorlat committed
58 59 60 61
/**
 * @defgroup network_parameters Controlling network parameters (ports, mtu...)
**/

smorlat's avatar
smorlat committed
62 63 64 65 66 67 68 69
/**
 * @defgroup authentication Managing authentication: userid and passwords
**/

/**
 * @defgroup call_logs Managing call logs
**/

Simon Morlat's avatar
Simon Morlat committed
70

smorlat's avatar
smorlat committed
71 72 73 74 75 76 77
/**
 * @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
78
**/
Simon Morlat's avatar
Simon Morlat committed
79 80 81 82 83 84 85 86 87 88 89

/**
 * @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
 *
**/