Ignore:
Timestamp:
Mar 12, 2009 6:11:37 PM (15 years ago)
Author:
bennylp
Message:

(Major) Task #737 and #738: integration of APS-Direct and Audiodev from aps-direct branch to trunk.

Location:
pjproject/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk

  • pjproject/trunk/pjmedia/include/pjmedia/sound_port.h

    r2394 r2506  
    2525 * @brief Media port connection abstraction to sound device. 
    2626 */ 
    27 #include <pjmedia/sound.h> 
     27#include <pjmedia-audiodev/audiodev.h> 
    2828#include <pjmedia/port.h> 
    2929 
     
    160160                                                    unsigned options, 
    161161                                                    pjmedia_snd_port **p_port); 
    162                                                
     162 
     163 
     164/** 
     165 * Create sound device port according to the specified parameters. 
     166 * 
     167 * @param pool              Pool to allocate sound port structure. 
     168 * @param prm               Sound device settings. 
     169 * @param p_port            Pointer to receive the sound device port instance. 
     170 * 
     171 * @return                  PJ_SUCCESS on success, or the appropriate error 
     172 *                          code. 
     173 */ 
     174PJ_DECL(pj_status_t) pjmedia_snd_port_create2(pj_pool_t *pool, 
     175                                              const pjmedia_aud_param *prm, 
     176                                              pjmedia_snd_port **p_port); 
     177 
    163178 
    164179/** 
     
    180195 * @return                  The sound stream instance. 
    181196 */ 
    182 PJ_DECL(pjmedia_snd_stream*) pjmedia_snd_port_get_snd_stream( 
     197PJ_DECL(pjmedia_aud_stream*) pjmedia_snd_port_get_snd_stream( 
    183198                                                pjmedia_snd_port *snd_port); 
    184199 
    185200 
    186201/** 
    187  * Configure the echo cancellation tail length. By default, echo canceller 
    188  * is enabled in the sound device with the default tail length. After the 
    189  * sound port is created, application can query the current echo canceller 
    190  * tail length by calling #pjmedia_snd_port_get_ec_tail. 
    191  * 
    192  * Note that you should only change the EC settings when the sound port 
    193  * is not connected to any downstream ports, otherwise race condition may 
    194  * occur. 
     202 * Change the echo cancellation settings. The echo cancellation settings  
     203 * should have been specified when this sound port was created, by setting 
     204 * the appropriate fields in the pjmedia_aud_param, because not all sound 
     205 * device implementation supports changing the EC setting once the device 
     206 * has been opened. 
     207 * 
     208 * The behavior of this function depends on whether device or software AEC 
     209 * is being used. If the device supports AEC, this function will forward 
     210 * the change request to the device and it will be up to the device whether 
     211 * to support the request. If software AEC is being used (the software EC 
     212 * will be used if the device does not support AEC), this function will 
     213 * change the software EC settings. 
    195214 * 
    196215 * @param snd_port          The sound device port. 
     
    200219 *                          be disabled. 
    201220 * @param options           The options to be passed to #pjmedia_echo_create(). 
     221 *                          This is only used if software EC is being used. 
    202222 * 
    203223 * @return                  PJ_SUCCESS on success. 
Note: See TracChangeset for help on using the changeset viewer.