Ignore:
Timestamp:
Mar 12, 2009 6:11:37 PM (13 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/pjsip/include/pjsua-lib/pjsua.h

    r2394 r2506  
    42014201    unsigned            ec_tail_len; 
    42024202 
     4203    /** 
     4204     * Audio capture buffer length, in milliseconds. 
     4205     * 
     4206     * Default: PJMEDIA_SND_DEFAULT_REC_LATENCY 
     4207     */ 
     4208    unsigned            snd_rec_latency; 
     4209 
     4210    /** 
     4211     * Audio playback buffer length, in milliseconds. 
     4212     * 
     4213     * Default: PJMEDIA_SND_DEFAULT_PLAY_LATENCY 
     4214     */ 
     4215    unsigned            snd_play_latency; 
     4216 
    42034217    /**  
    42044218     * Jitter buffer initial prefetch delay in msec. The value must be 
     
    42734287    /** 
    42744288     * Specify idle time of sound device before it is automatically closed, 
    4275      * in seconds. 
    4276      * 
    4277      * Default : -1 (Disable the auto-close feature of sound device) 
     4289     * in seconds. Use value -1 to disable the auto-close feature of sound 
     4290     * device 
     4291     * 
     4292     * Default : 1 
    42784293     */ 
    42794294    int                 snd_auto_close_time; 
     
    47884803 
    47894804/** 
    4790  * Enum all sound devices installed in the system. 
     4805 * Enum all audio devices installed in the system. 
    47914806 * 
    47924807 * @param info          Array of info to be initialized. 
     
    47964811 * 
    47974812 * @return              PJ_SUCCESS on success, or the appropriate error code. 
     4813 */ 
     4814PJ_DECL(pj_status_t) pjsua_enum_aud_devs(pjmedia_aud_dev_info info[], 
     4815                                         unsigned *count); 
     4816 
     4817/** 
     4818 * Enum all sound devices installed in the system (old API). 
     4819 * 
     4820 * @param info          Array of info to be initialized. 
     4821 * @param count         On input, specifies max elements in the array. 
     4822 *                      On return, it contains actual number of elements 
     4823 *                      that have been initialized. 
     4824 * 
     4825 * @return              PJ_SUCCESS on success, or the appropriate error code. 
    47984826 * 
    47994827 * 
     
    48074835PJ_DECL(pj_status_t) pjsua_enum_snd_devs(pjmedia_snd_dev_info info[], 
    48084836                                         unsigned *count); 
    4809  
    4810  
    48114837 
    48124838/** 
     
    48804906 
    48814907/** 
    4882  * Configure the echo canceller tail length of the sound port. 
     4908 * Change the echo cancellation settings. 
     4909 * 
     4910 * The behavior of this function depends on whether the sound device is 
     4911 * currently active, and if it is, whether device or software AEC is  
     4912 * being used.  
     4913 * 
     4914 * If the sound device is currently active, and if the device supports AEC, 
     4915 * this function will forward the change request to the device and it will 
     4916 * be up to the device on whether support the request. If software AEC is 
     4917 * being used (the software EC will be used if the device does not support 
     4918 * AEC), this function will change the software EC settings. In all cases, 
     4919 * the setting will be saved for future opening of the sound device. 
     4920 * 
     4921 * If the sound device is not currently active, this will only change the 
     4922 * default AEC settings and the setting will be applied next time the  
     4923 * sound device is opened. 
    48834924 * 
    48844925 * @param tail_ms       The tail length, in miliseconds. Set to zero to 
     
    48984939 
    48994940/** 
    4900  * Get current echo canceller tail length. 
     4941 * Get current echo canceller tail length.  
    49014942 * 
    49024943 * @param p_tail_ms     Pointer to receive the tail length, in miliseconds.  
     
    49124953PJ_DECL(pj_status_t) pjsua_get_ec_tail(unsigned *p_tail_ms); 
    49134954 
     4955 
     4956/** 
     4957 * Check whether the sound device is currently active. The sound device 
     4958 * may be inactive if the application has set the auto close feature to 
     4959 * non-zero (the snd_auto_close_time setting in #pjsua_media_config), or 
     4960 * if null sound device or no sound device has been configured via the 
     4961 * #pjsua_set_no_snd_dev() function. 
     4962 */ 
     4963PJ_DECL(pj_bool_t) pjsua_snd_is_active(void); 
     4964 
     4965     
     4966/** 
     4967 * Configure sound device setting to the sound device being used. If sound  
     4968 * device is currently active, the function will forward the setting to the 
     4969 * sound device instance to be applied immediately, if it supports it.  
     4970 * 
     4971 * The setting will be saved for future opening of the sound device, if the  
     4972 * "keep" argument is set to non-zero. If the sound device is currently 
     4973 * inactive, and the "keep" argument is false, this function will return 
     4974 * error. 
     4975 *  
     4976 * Note that in case the setting is kept for future use, it will be applied 
     4977 * to any devices, even when application has changed the sound device to be 
     4978 * used. 
     4979 * 
     4980 * Note also that the echo cancellation setting should be set with  
     4981 * #pjsua_set_ec() API instead. 
     4982 * 
     4983 * See also #pjmedia_aud_stream_set_cap() for more information about setting 
     4984 * an audio device capability. 
     4985 * 
     4986 * @param cap           The sound device setting to change. 
     4987 * @param pval          Pointer to value. Please see #pjmedia_aud_dev_cap 
     4988 *                      documentation about the type of value to be  
     4989 *                      supplied for each setting. 
     4990 * @param keep          Specify whether the setting is to be kept for future 
     4991 *                      use. 
     4992 * 
     4993 * @return              PJ_SUCCESS on success or the appropriate error code. 
     4994 */ 
     4995PJ_DECL(pj_status_t) pjsua_snd_set_setting(pjmedia_aud_dev_cap cap, 
     4996                                           const void *pval, 
     4997                                           pj_bool_t keep); 
     4998 
     4999/** 
     5000 * Retrieve a sound device setting. If sound device is currently active, 
     5001 * the function will forward the request to the sound device. If sound device 
     5002 * is currently inactive, and if application had previously set the setting 
     5003 * and mark the setting as kept, then that setting will be returned. 
     5004 * Otherwise, this function will return error. 
     5005 * 
     5006 * Note that echo cancellation settings should be retrieved with  
     5007 * #pjsua_get_ec_tail() API instead. 
     5008 * 
     5009 * @param cap           The sound device setting to retrieve. 
     5010 * @param pval          Pointer to receive the value.  
     5011 *                      Please see #pjmedia_aud_dev_cap documentation about 
     5012 *                      the type of value to be supplied for each setting. 
     5013 * 
     5014 * @return              PJ_SUCCESS on success or the appropriate error code. 
     5015 */ 
     5016PJ_DECL(pj_status_t) pjsua_snd_get_setting(pjmedia_aud_dev_cap cap, 
     5017                                           void *pval); 
    49145018 
    49155019 
Note: See TracChangeset for help on using the changeset viewer.