pjsip库的头文件文件夹

/* $Id: pjsua.h 6004 2019-05-24 03:32:17Z riza $ */ /* * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com) * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org> * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef __PJSUA_H__ #define __PJSUA_H__ /** * @file pjsua.h * @brief PJSUA API. */ /* Include all PJSIP core headers. */ #include <pjsip.h> /* Include all PJMEDIA headers. */ #include <pjmedia.h> /* Include all PJMEDIA-CODEC headers. */ #include <pjmedia-codec.h> /* Videodev too */ #include <pjmedia_videodev.h> /* Include all PJSIP-UA headers */ #include <pjsip_ua.h> /* Include all PJSIP-SIMPLE headers */ #include <pjsip_simple.h> /* Include all PJNATH headers */ #include <pjnath.h> /* Include all PJLIB-UTIL headers. */ #include <pjlib-util.h> /* Include all PJLIB headers. */ #include <pjlib.h> PJ_BEGIN_DECL /** * @defgroup PJSUA_LIB PJSUA API - High Level Softphone API * @brief Very high level API for constructing SIP UA applications. * @{ * * @section pjsua_api_intro A SIP User Agent API for C/C++ * * PJSUA API is very high level API for constructing SIP multimedia user agent * applications. It wraps together the signaling and media functionalities * into an easy to use call API, provides account management, buddy * management, presence, instant messaging, along with multimedia * features such as conferencing, file streaming, local playback, * voice recording, and so on. * * @subsection pjsua_for_c_cpp C/C++ Binding * Application must link with <b>pjsua-lib</b> to use this API. In addition, * this library depends on the following libraries: * - <b>pjsip-ua</b>, * - <b>pjsip-simple</b>, * - <b>pjsip-core</b>, * - <b>pjmedia</b>, * - <b>pjmedia-codec</b>, * - <b>pjlib-util</b>, and * - <b>pjlib</b>, * * so application must also link with these libraries as well. For more * information, please refer to * <A HREF="http://www.pjsip.org/using.htm">Getting Started with PJSIP</A> * page. * * @section pjsua_samples * * Few samples are provided: * - @ref page_pjsip_sample_simple_pjsuaua_c\n Very simple SIP User Agent with registration, call, and media, using PJSUA-API, all in under 200 lines of code. - @ref page_pjsip_samples_pjsua\n This is the reference implementation for PJSIP and PJMEDIA. PJSUA is a console based application, designed to be simple enough to be readble, but powerful enough to demonstrate all features available in PJSIP and PJMEDIA.\n * @section root_using_pjsua_lib Using PJSUA API * * Please refer to @ref PJSUA_LIB_BASE on how to create and initialize the API. * And then see the Modules on the bottom of this page for more information * about specific subject. */ /***************************************************************************** * BASE API */ /** * @defgroup PJSUA_LIB_BASE PJSUA-API Basic API * @ingroup PJSUA_LIB * @brief Basic application creation/initialization, logging configuration, etc. * @{ * * The base PJSUA API controls PJSUA creation, initialization, and startup, and * also provides various auxiliary functions. * * @section using_pjsua_lib Using PJSUA Library * * @subsection creating_pjsua_lib Creating PJSUA * * Before anything else, application must create PJSUA by calling * #pjsua_create(). * This, among other things, will initialize PJLIB, which is crucial before * any PJLIB functions can be called, PJLIB-UTIL, and create a SIP endpoint. * * After this function is called, application can create a memory pool (with * #pjsua_pool_create()) and read configurations from command line or file to * build the settings to initialize PJSUA below. * * @subsection init_pjsua_lib Initializing PJSUA * * After PJSUA is created, application can initialize PJSUA by calling * #pjsua_init(). This function takes several optional configuration settings * in the argument, if application wants to set them. * * @subsubsection init_pjsua_lib_c_cpp PJSUA-LIB Initialization (in C) * Sample code to initialize PJSUA in C code: \code #include <pjsua-lib/pjsua.h> #define THIS_FILE __FILE__ static pj_status_t app_init(void) { pjsua_config ua_cfg; pjsua_logging_config log_cfg; pjsua_media_config media_cfg; pj_status_t status; // Must create pjsua before anything else! status = pjsua_create(); if (status != PJ_SUCCESS) { pjsua_perror(THIS_FILE, "Error initializing pjsua", status); return status; } // Initialize configs with default settings. pjsua_config_default(&ua_cfg); pjsua_logging_config_default(&log_cfg); pjsua_media_config_default(&media_cfg); // At the very least, application would want to override // the call callbacks in pjsua_config: ua_cfg.cb.on_incoming_call = ... ua_cfg.cb.on_call_state = .. ... // Customize other settings (or initialize them from application specific // configuration file): ... // Initialize pjsua status = pjsua_init(&ua_cfg, &log_cfg, &media_cfg); if (status != PJ_SUCCESS) { pjsua_perror(THIS_FILE, "Error initializing pjsua", status); return status; } . ... } \endcode * * * @subsection other_init_pjsua_lib Other Initialization * * After PJSUA is initialized with #pjsua_init(), application will normally * need/want to perform the following tasks: * * - create SIP transport with #pjsua_transport_create(). Application would * to call #pjsua_transport_create() for each transport types that it * wants to support (for example, UDP, TCP, and TLS). Please see * @ref PJSUA_LIB_TRANSPORT section for more info. * - create one or more SIP accounts with #pjsua_acc_add() or * #pjsua_acc_add_local(). The SIP account is used for registering with * the SIP server, if any. Please see @ref PJSUA_LIB_ACC for more info. * - add one or more buddies with #pjsua_buddy_add(). Please see * @ref PJSUA_LIB_BUDDY section for more info. * - optionally configure the sound device, codec settings, and other * media settings. Please see @ref PJSUA_LIB_MEDIA for more info. * * * @subsection starting_pjsua_lib Starting PJSUA * * After all initializations have been done, application must call * #pjsua_start() to start PJSUA. This function will check that all settings * have been properly configured, and apply default settings when they haven't, * or report error status when it is unable to recover from missing settings. * * Most settings can be changed during run-time. For example, application * may add, modify, or delete accounts, buddies, or change media settings * during run-time. * * @subsubsection starting_pjsua_lib_c C Example for Starting PJSUA * Sample code: \code static pj_status_t app_run(void) { pj_status_t status; // Start pjsua status = pjsua_start(); if (status != PJ_SUCCESS) { pjsua_destroy(); pjsua_perror(THIS_FILE, "Error starting pjsua", status); return status; } // Run application loop while (1) { char choice[10]; printf("Select menu: "); fg