Skip to content

Commit 5b40b87

Browse files
authored
Update WebRTC docs (#4405)
1 parent 6dd67c3 commit 5b40b87

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

pjmedia/include/pjmedia/config.h

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,13 +735,26 @@
735735

736736

737737
/**
738-
* WebRtc Acoustic Echo Cancellation (AEC).
738+
* WebRTC Acoustic Echo Cancellation (AEC).
739+
* Please check https://github.com/pjsip/pjproject/issues/1888 for more info.
740+
*
739741
* By default is disabled.
740742
*/
741743
#ifndef PJMEDIA_HAS_WEBRTC_AEC
742744
# define PJMEDIA_HAS_WEBRTC_AEC 0
743745
#endif
744746

747+
/**
748+
* WebRTC Acoustic Echo Cancellation 3 (WebRTC AEC3).
749+
* Please check https://github.com/pjsip/pjproject/pull/2722 and
750+
* https://github.com/pjsip/pjproject/pull/2775 for more info.
751+
*
752+
* By default is disabled.
753+
*/
754+
#ifndef PJMEDIA_HAS_WEBRTC_AEC3
755+
# define PJMEDIA_HAS_WEBRTC_AEC3 0
756+
#endif
757+
745758
/**
746759
* Specify whether WebRtc EC should use its mobile version AEC.
747760
*

pjmedia/include/pjmedia/echo.h

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,12 +115,16 @@ typedef enum pjmedia_echo_flag
115115
/**
116116
* If PJMEDIA_ECHO_USE_NOISE_SUPPRESSOR flag is specified, the echo
117117
* canceller will also apply noise suppressor method to reduce noise.
118+
*
119+
* Currently this is only effective on WebRTC AEC & WebRTC AEC3 backends.
118120
*/
119121
PJMEDIA_ECHO_USE_NOISE_SUPPRESSOR = 128,
120122

121123
/**
122124
* If PJMEDIA_ECHO_USE_GAIN_CONTROLLER flag is specified, the echo
123125
* canceller will also apply automatic gain control.
126+
*
127+
* Currently this is only effective on WebRTC AEC3 backend.
124128
*/
125129
PJMEDIA_ECHO_USE_GAIN_CONTROLLER = 256,
126130

@@ -135,20 +139,26 @@ typedef enum pjmedia_echo_flag
135139
* Use conservative aggressiveness setting for the echo canceller
136140
* algorithm. This setting is mutually exclusive with the other
137141
* aggressiveness settings.
142+
*
143+
* Currently this is only effective on WebRTC AEC backend.
138144
*/
139145
PJMEDIA_ECHO_AGGRESSIVENESS_CONSERVATIVE = 0x1000,
140146

141147
/**
142148
* Use moderate aggressiveness setting for the echo canceller algorithm.
143149
* This setting is mutually exclusive with the other aggressiveness
144150
* settings.
151+
*
152+
* Currently this is only effective on WebRTC AEC backend.
145153
*/
146154
PJMEDIA_ECHO_AGGRESSIVENESS_MODERATE = 0x2000,
147155

148156
/**
149157
* Use aggressive aggressiveness setting for the echo canceller
150158
* algorithm. This setting is mutually exclusive with the other
151159
* aggressiveness settings.
160+
*
161+
* Currently this is only effective on WebRTC AEC backend.
152162
*/
153163
PJMEDIA_ECHO_AGGRESSIVENESS_AGGRESSIVE = 0x3000,
154164

0 commit comments

Comments
 (0)