sjero.net Git - linphone/blob - linphone/coreapi/help/doxygen.dox.in

   1 /**
   2  * @mainpage
   3  *
   4  * @see http://www.linphone.org
   5  *
   6  * @section what_is_it What is liblinphone
   7  *
   8  * Liblinphone is a high level library for bringing SIP video call functionnality
   9  * into an application. It aims at making easy the integration of the SIP
  10  * video calls into any applications. All variants of linphone are directly based
  11  * on it:
  12  * - linphone (gtk interface)
  13  *
  14  * - linphonec (console interface)
  15  *
  16  * Liblinphone is GPL (see COPYING file). Please understand the licencing details
  17  * before using it!
  18  *
  19  * For any use of this library beyond the rights granted to you by the
  20  * GPL license, please contact Belledonne Communications
  21  * (contact@belledonne-communications.com)
  22  *
  23  *
  24 **/
  25
  26 /**
  27  * @page liblinphone_license COPYING
  28  * @verbinclude COPYING
  29  */
  30
  31
  32 /**
  33  * @defgroup initializing Initialization and destruction
  34  *
  35 **/
  36
  37 /**
  38  * @defgroup call_control Call control
  39  *
  40  * The application can initiate outgoing calls with linphone_core_invite().
  41  * It is notified of incoming call thanks to the inv_recv callback of the LinphoneCoreVTable
  42  * structure that is passed at creation of the LinphoneCore object.
  43  * It can then answer calls with linphone_core_accept_call().
  44  * Calls can be terminated or declined with linphone_core_terminate_call().
  45  * The application is notified when the remote party hangups thanks to
  46  * bye_recv callback of the #LinphoneCoreVTable.
  47 **/
  48
  49 /**
  50  * @defgroup media_parameters Controlling media parameters
  51 **/
  52
  53 /**
  54  * @defgroup proxies Managing proxies
  55 **/
  56
  57 /**
  58  * @defgroup network_parameters Controlling network parameters (ports, mtu...)
  59 **/
  60
  61 /**
  62  * @defgroup authentication Managing authentication: userid and passwords
  63 **/
  64
  65 /**
  66  * @defgroup call_logs Managing call logs
  67 **/
  68
  69 /**
  70  * @defgroup linphone_address SIP address parser API.
  71  * This api is useful for manipulating SIP addresses ('from' or 'to' headers).
  72 **/
  73
  74 /**
  75  * @defgroup misc Miscenalleous: logs, version strings, config storage
  76 **/