Edit

Share via


KSPROPERTY_AUDIO_EQ_BANDS

The KSPROPERTY_AUDIO_EQ_BANDS property specifies the set of frequency bands from an equalization table. This is a get-only property of a channel in an EQ node (KSNODETYPE_EQUALIZER).

Usage Summary Table

Get Set Target Property descriptor type Property value type

Yes

No

Filter

KSNODEPROPERTY_AUDIO_CHANNEL

ULONG array

The property value (operation data) is an array of ULONG elements:

  ULONG  CenterFreqVal[N];

If the channel's equalization table contains entries for N frequency bands, the array contains N elements and each array element specifies the center frequency of the corresponding band. The miniport driver writes into each element an integer frequency value that is expressed in hertz (Hz). The assignment of equalization bands to array elements is shown in the following table.

Array Element Description CenterFreqVal[0]

The center frequency (in Hz) for equalization band 0.

CenterFreqVal[1]

The center frequency (in Hz) for equalization band 1.

...

CenterFreqVal[N-1]

The center frequency (in Hz) for equalization band N-1.

Return Value

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

Remarks

The number of equalization bands can be determined by first submitting a KSPROPERTY_AUDIO_NUM_EQ_BANDS request.

The equalization levels for the frequency bands are specified by the KSPROPERTY_AUDIO_EQ_LEVEL property.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See also

KSNODEPROPERTY_AUDIO_CHANNEL

KSNODETYPE_EQUALIZER

KSPROPERTY_AUDIO_NUM_EQ_BANDS

KSPROPERTY_AUDIO_EQ_LEVEL