KSPROPERTY_SYNTH_CHANNELGROUPS

The KSPROPERTY_SYNTH_CHANNELGROUPS property is used by the system to set or get the number of active channel groups on the pin instance. Channel groups are numbered, beginning with zero, on each pin instance.

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

Yes

Pin

KSNODEPROPERTY

ULONG

 

The property value (operation data) is of type ULONG and specifies how many channel groups the pin supports. If a pin supports n channel groups, the channel groups on the pin are numbered from 0 to n-1.

Return Value

A KSPROPERTY_SYNTH_CAPS property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code. The following table shows some of the possible failure codes.

Status CodeMeaning

STATUS_BUFFER_TOO_SMALL

The buffer was too small to complete the operation.

STATUS_UNSUCCESSFUL

The operation did not complete successfully.

 

Remarks

For more information about channel groups, see the descriptions of the IDirectMusicPort::GetNumChannelGroups and IDirectMusicPort::SetNumChannelGroups methods in the Microsoft Windows SDK documentation.

Requirements

Header

Dmusprop.h (include Dmusprop.h)

See also

KSNODEPROPERTY
IDirectMusicSynth::SetNumChannelGroups

 

 

Send comments about this topic to Microsoft

Show: