KSPROPERTY_AUDIO_EQ_LEVEL

The KSPROPERTY_AUDIO_EQ_LEVEL property specifies the equalization levels for an equalization table that contains entries for n frequency bands. This is a property of a channel in an EQ node (KSNODETYPE_EQUALIZER).

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

Yes

Filter

KSNODEPROPERTY_AUDIO_CHANNEL

LONG array

 

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


  LONG  Level[N];

If the channel's equalization table contains entries for N frequency bands, the array contains N elements and each element specifies the level for one of the bands in the equalization table. The assignment of bands to array elements is shown in the following table.

Array ElementDescription

Level[0]

Level for band 0.

Level[1]

Level for band 1.

...

Level[N-1]

Level for band N-1.

 

Level values use the following scale:

-2147483648 is -Infinity decibels (attenuation),

-2147483647 is -32767.99998474 decibels (attenuation), and

+2147483647 is +32767.99998474 decibels (gain).

A decibel range represented by integer values -2147483648 to +2147483647, where

This scale has a resolution of 1/65536 decibel.

Return Value

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

Remarks

The filter will succeed a KSPROPERTY_AUDIO_EQ_LEVEL set-property request that specifies a value that is beyond the range of the filter but will clamp the value to the supported range. In a subsequent request to get this property, however, it will output the actual value used.

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

The center frequencies of the equalization bands are specified by the KSPROPERTY_AUDIO_EQ_BANDS property.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See also

KSNODEPROPERTY_AUDIO_CHANNEL
KSNODETYPE_EQUALIZER
KSPROPERTY_AUDIO_NUM_EQ_BANDS
KSPROPERTY_AUDIO_EQ_BANDS

 

 

Send comments about this topic to Microsoft

Show: