Edit

KSPROPERTY_AUDIO_CHORUS_LEVEL

  • Article

The KSPROPERTY_AUDIO_CHORUS_LEVEL property specifies the chorus level. 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 (operation data) is of type ULONG and specifies the chorus level. Chorus-level values follow a linear range from 0 to 100*(65536-1/65536) percent:

  • The value 0x00010000 represents 100 percent.

  • The value 0xFFFFFFFF represents 100*(65536-1/65536) percent.

Return Value

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

Remarks

This property is used to get and set the volume level of the chorus echo.

Chorus is a voice-doubling effect that is created by echoing the original sound with a slight delay and slightly modulating the delay of the echo. For more information, see the description of the IDirectSoundFXChorus interface in the Microsoft Windows SDK documentation.

Requirements

Header

 Ksmedia.h (include Ksmedia.h)

See also

KSNODETYPE_CHORUS

KSNODEPROPERTY