Expand Minimize

KSPROPERTY_AUDIO_SURROUND_ENCODE

The KSPROPERTY_AUDIO_SURROUND_ENCODE property specifies whether the filter's surround encoder is enabled or disabled. A surround-encoder node (KSNODETYPE_PROLOGIC_ENCODER) performs Dolby Surround Pro Logic encoding.

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

Yes

Filter

KSNODEPROPERTY

BOOL

 

The property value (operation data) is of type BOOL and indicates whether the surround-encoder node is enabled or not. A value of TRUE indicates that the surround-encoder node is enabled. FALSE indicates that it is disabled.

Return Value

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

Remarks

In Microsoft Windows XP and later, the KMixer system driver supports the KSPROPERTY_AUDIO_SURROUND_ENCODE property.

If enabled, the surround-encoder node encodes the four-channel input stream (with channels for left, right, center, and back speakers) to a surround-encoded stereo output stream. This output stream can be decoded by a KSNODETYPE_PROLOGIC_DECODER node, for example. It can also be played through the audio device's analog stereo outputs, which can be connected to an external surround decoder that directly drives left, right, center, and back speakers.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See also

KSNODEPROPERTY
KSNODETYPE_PROLOGIC_ENCODER
KSNODETYPE_PROLOGIC_DECODER

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft