doxygen.dox 5.2 KB
 jehan committed Oct 07, 2010 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 /** * @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.
A created proxy config using linphone_proxy_config_new(), once configured, must be added to #LinphoneCore using function linphone_core_add_proxy_config(). *
It is recommended to set a default \link #LinphoneProxyConfig proxy config \endlink using function linphone_core_set_default_proxy(). Once done, if \link #LinphoneProxyConfig a proxy config \endlink has been configured with attribute \link linphone_proxy_config_enable_register() enable register \endlink , next call to linphone_core_iterate() triggers a SIP register. *
Registration status is reported by #LinphoneRegistrationStateCb. *
*
This pseudo code demonstrate basic registration operation: *
For more complete tutorial can be found see : \ref registration_tutorials "Registration tutorial" **/ /** * @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 tutorials Tutorials: * **/