Expand Minimize

KSPROPERTY_AUDIO_CHANNEL_CONFIG

The KSPROPERTY_AUDIO_CHANNEL_CONFIG property specifies the actual spatial placement of channels in the audio stream that a node outputs.

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

Yes

Filter/Pin

KSNODEPROPERTY

KSAUDIO_CHANNEL_CONFIG

 

The property value (operation data) is a structure of type KSAUDIO_CHANNEL_CONFIG. This structure specifies the channels that are contained in the output stream and the assignment of those channels to speakers.

Return Value

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

Remarks

When used as a property of a DAC node (KSNODETYPE_DAC) or 3D node (KSNODETYPE_3D_EFFECTS), the KSPROPERTY_AUDIO_CHANNEL_CONFIG property specifies the DirectSound speaker configuration. For stereo speaker configurations, this property is used in conjunction with the KSPROPERTY_AUDIO_STEREO_SPEAKER_GEOMETRY property, which distinguishes between headphones and several stereo speaker configurations. For more information about speaker configurations, see DirectSound Speaker-Configuration Settings.

DirectSound also uses the KSPROPERTY_AUDIO_CHANNEL_CONFIG property to query a "pan" node for its channel configuration. A pan node is the second volume node (KSNODETYPE_VOLUME) on a mixer pin that meets the DirectSound node-ordering requirements. DirectSound implementation of the IDirectSoundBuffer::SetPan method (described in the Microsoft Windows SDK documentation) uses the pan node's KSPROPERTY_AUDIO_VOLUMELEVEL property to control panning.

DirectSound treats KSPROPERTY_AUDIO_CHANNEL_CONFIG as a filter property on a DAC node, and as a pin property on volume and 3D nodes.

Clients also use this property to select the format of the stream that a KSNODETYPE_PROLOGIC_DECODER node outputs.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See also

KSNODEPROPERTY
KSAUDIO_CHANNEL_CONFIG
KSNODETYPE_DAC
KSNODETYPE_3D_EFFECTS
KSNODETYPE_VOLUME
KSNODETYPE_PROLOGIC_DECODER
KSPROPERTY_AUDIO_STEREO_SPEAKER_GEOMETRY
KSPROPERTY_AUDIO_VOLUMELEVEL

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft