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:

1. Call startUserAcousticEchoCancellerReference().
2. To provide reference audio data, call putUserAcousticEchoCancellerReference() with the reference audio data.
3. 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

• startUserAcousticEchoCancellerReference() of PlanetKitCall ^{iOS, macOS}
• putUserAcousticEchoCancellerReference() of PlanetKitCall ^{iOS, macOS}
• stopUserAcousticEchoCancellerReference() of PlanetKitCall ^{iOS, macOS}

Group call

• startUserAcousticEchoCancellerReference() of PlanetKitConference ^{iOS, macOS}
• putUserAcousticEchoCancellerReference() of PlanetKitConference ^{iOS, macOS}
• stopUserAcousticEchoCancellerReference() of PlanetKitConference ^{iOS, macOS}