Application AEC reference
In certain cases, you may want to edit audio before outputting it to speakers, such as for mixing sound effects. However, the mixed sound effects may be echoed into the local microphone. Mixed sound effects cannot be removed by the acoustic echo canceller (AEC) module of PlanetKit.
You can use the application AEC reference to remove such mixed sound effects.
| Supported call type | Minimum SDK version |
|---|---|
| 1-to-1 call, group call (conference) | PlanetKit 3.8 |
How to use the application AEC reference
To use the application AEC reference, take the following steps:
- Call
StartUserAcousticEchoCancellerReference(). - To provide reference audio data, call
PutUserAcousticEchoCancellerReference()with the reference audio data. - To stop providing the reference audio data, call
StopUserAcousticEchoCancellerReference().
Interface changes
The following table shows changes on the APIs related to application AEC reference.
| PlanetKit version | Supported Methods | Note |
|---|---|---|
| 5.2 or higher | StartUserAcousticEchoCancellerReference()PutUserAcousticEchoCancellerReference()StopUserAcousticEchoCancellerReference() | API naming has been changed. |
| 3.8 through 5.1 | StartAECReferenceData()PutAECReferenceData()StopAECReferenceData() | useAECReference has been removed. |
| 3.7 | PutAECReferenceData() | Set useAECReference in a call parameter or conference parameter to true to use the application AEC reference. |
Related API
APIs related to the application AEC reference are as follows.
1-to-1 call
-
PlanetKitCall::StartUserAcousticEchoCancellerReference() -
PlanetKitCall::PutUserAcousticEchoCancellerReference() -
PlanetKitCall::StopUserAcousticEchoCancellerReference()