KSPROPERTY_AUDIO_CHORUS_MODULATION_RATE

  • Article

The KSPROPERTY_AUDIO_CHORUS_MODULATION_RATE property specifies the chorus modulation rate. This is a property of a chorus node (KSNODETYPE_CHORUS).

Usage Summary Table

Get Set Target Property descriptor type Property value type

Yes

Yes

Filter

KSNODEPROPERTY

ULONG

The property value is of type ULONG and it specifies the chorus modulation rate. It is expressed in Hz. The value can range from 0 to 255.9961 in 1/256th increments. To accommodate this, the property value should be expressed as a fixed-point 16.16 value, where the following is true:

  • The value 0x00010000 represents 1Hz
  • The value 0xFFFFFFFF represents (65536-1/65536) Hz

Return Value

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

Requirements

Version

Windows Vista

Header

 Ksmedia.h

See also

KSNODETYPE_CHORUS