Commit d6a8aef9 authored by Ghislain MARY's avatar Ghislain MARY
Browse files

Fix terminology about speaker and receiver in the documentation.

parent d79f3d3f
...@@ -224,7 +224,7 @@ On Android devices, there are two kind of situations regarding echo cancellation ...@@ -224,7 +224,7 @@ On Android devices, there are two kind of situations regarding echo cancellation
<br> <br>
<b>Echo calibration tool</b> <b>Echo calibration tool</b>
<br> <br>
The echo calibration procedure is a five second audio test which consists in playing small beeps to the speaker while the microphone input is recorded. The echo calibration procedure is a five second audio test which consists in playing small beeps to the receiver while the microphone input is recorded.
If the device is subject to echo (or doesn't have hardware echo cancellation), then beeps recorded by the microphone will be detected and a measurement of echo delay can be computed. If the device is subject to echo (or doesn't have hardware echo cancellation), then beeps recorded by the microphone will be detected and a measurement of echo delay can be computed.
Echo calibration procedure can be started by calling {@link org.linphone.core.LinphoneCore#startEchoCalibration LinphoneCore.startEchoCalibration}. Echo calibration procedure can be started by calling {@link org.linphone.core.LinphoneCore#startEchoCalibration LinphoneCore.startEchoCalibration}.
The measurement of the echo delay is important to save CPU computations by restricting the temporal area where the software echo canceller has to perform. The measurement of the echo delay is important to save CPU computations by restricting the temporal area where the software echo canceller has to perform.
...@@ -233,7 +233,7 @@ The measurement of the echo delay is important to save CPU computations by restr ...@@ -233,7 +233,7 @@ The measurement of the echo delay is important to save CPU computations by restr
<br> <br>
<b>Echo limiter</b> <b>Echo limiter</b>
<br> <br>
The echo limiter is a liblinphone algorithm to clear out echo with a brute force method. It consists in cutting down the microphone signal when active signal is played by the speaker, to prevent voice to feed back into the microphone. This algorithm has disadvantages compared to the hardware or software echo cancellers because the remote user will be not hear any background noise when speaking, which is confusing. As a result the echo limiter method shall be used only under situation where echo canceller can't perform, that is loud signals with heavy saturations, which usually happens when using the device in speaker mode. Echo limiter can be enabled or disabled during a call with {@link org.linphone.core.LinphoneCall#enableEchoLimiter LinphoneCall.enableEchoLimiter()}. The echo limiter is a liblinphone algorithm to clear out echo with a brute force method. It consists in cutting down the microphone signal when active signal is played by the speaker/receiver, to prevent voice to feed back into the microphone. This algorithm has disadvantages compared to the hardware or software echo cancellers because the remote user will be not hear any background noise when speaking, which is confusing. As a result the echo limiter method shall be used only under situation where echo canceller can't perform, that is loud signals with heavy saturations, which usually happens when using the device in speaker mode. Echo limiter can be enabled or disabled during a call with {@link org.linphone.core.LinphoneCall#enableEchoLimiter LinphoneCall.enableEchoLimiter()}.
<br> <br>
<br> <br>
...@@ -253,14 +253,14 @@ In order to benefit from the best echo cancellation solution, we recommend appli ...@@ -253,14 +253,14 @@ In order to benefit from the best echo cancellation solution, we recommend appli
</li> </li>
</ul> </ul>
During calls, the echo limiter should be disabled while using the earpiece, but enabled while using the speaker. It is also recommended to disable echo canceller while using the echo limiter, because the first one would be useless. Therefore you should have the following situations: During calls, the echo limiter should be disabled while using the receiver, but enabled while using the hands-free speaker. It is also recommended to disable echo canceller while using the echo limiter, because the first one would be useless. Therefore you should have the following situations:
<ul> <ul>
<li>While using the earpiece</li> <li>While using the receiver</li>
<ul> <ul>
<li>Echo canceller enabled, unless the device has hardware echo cancellation</li> <li>Echo canceller enabled, unless the device has hardware echo cancellation</li>
<li>Echo limiter disabled</li> <li>Echo limiter disabled</li>
</ul> </ul>
<li>While using the speaker</li> <li>While using the hands-free speaker</li>
<ul> <ul>
<li>Echo canceller disabled</li> <li>Echo canceller disabled</li>
<li>Echo limiter enabled, unless the device has hardware echo cancellation.</li> <li>Echo limiter enabled, unless the device has hardware echo cancellation.</li>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment