KSPROPERTY_AEC_MODE

The KSPROPERTY_AEC_MODE property is used to control an AEC node's mode of operation. This is an optional property of an AEC node (KSNODETYPE_ACOUSTIC_ECHO_CANCEL).

Usage Summary Table

Get Set Target Property descriptor type Property value type

Yes

Yes

Pin

KSNODEPROPERTY

ULONG

The property value (operation data) is of type ULONG and can be set to one of the following mode constants from header file Ksmedia.h:

  • AEC_MODE_PASS_THROUGH

    In pass-through mode, the AEC node allows capture and render data to simply pass through the node without being modified.

  • AEC_MODE_HALF_DUPLEX

    The AEC algorithm is running in half-duplex mode, which is similar in operation to a speaker phone. In this mode, the speaker volume is muted whenever the local person's speech has a higher volume level than the remote person's.

  • AEC_MODE_FULL_DUPLEX

    The AEC algorithm is running in full-duplex mode.

Pass-through mode is the default. When the filter containing the AEC node is created or the node is reset, the node is initially configured to operate in pass-through mode.

In the initial release of Windows XP, the AEC algorithm that the AEC system filter uses does not support the half-duplex mode.

Return Value

A KSPROPERTY_AEC_MODE property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See also

KSNODEPROPERTY

KSNODETYPE_ACOUSTIC_ECHO_CANCEL