AudioEchoCancellation interface

Echo cancellation configuration for server-side audio processing.

Properties

channels

Number of input audio channels.

  • 1: Mono input (default).
  • 2: Interleaved stereo input where channel 0 is the microphone signal and channel 1 is the echo reference signal. When set to 2, reference_source must be client and input_audio_format must be pcm16.
referenceSource

The source of the echo cancellation reference signal.

  • server: EC uses the internal TTS loopback as the reference signal (default, existing behavior).
  • client: EC uses the client-supplied reference channel (ch1 of stereo input). Internal TTS loopback is skipped.
type

The type of echo cancellation model to use.

Property Details

channels

Number of input audio channels.

  • 1: Mono input (default).
  • 2: Interleaved stereo input where channel 0 is the microphone signal and channel 1 is the echo reference signal. When set to 2, reference_source must be client and input_audio_format must be pcm16.
channels?: number

Property Value

number

referenceSource

The source of the echo cancellation reference signal.

  • server: EC uses the internal TTS loopback as the reference signal (default, existing behavior).
  • client: EC uses the client-supplied reference channel (ch1 of stereo input). Internal TTS loopback is skipped.
referenceSource?: string

Property Value

string

type

The type of echo cancellation model to use.

type: "server_echo_cancellation"

Property Value

"server_echo_cancellation"