Skip to content

Latest commit

 

History

History
153 lines (88 loc) · 4.01 KB

ns-dmusprop-_synth_portparams.md

File metadata and controls

153 lines (88 loc) · 4.01 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NS:dmusprop._SYNTH_PORTPARAMS
_SYNTH_PORTPARAMS (dmusprop.h)
The SYNTH_PORTPARAMS structure contains the configuration parameters for a DirectMusic port, which is a DirectMusic term for a device that sends or receives music data.
audio\synth_portparams.htm
audio
05/08/2018
SYNTH_PORTPARAMS structure
*PSYNTH_PORTPARAMS, PSYNTH_PORTPARAMS, PSYNTH_PORTPARAMS structure pointer [Audio Devices], SYNTH_PORTPARAMS, SYNTH_PORTPARAMS structure [Audio Devices], _SYNTH_PORTPARAMS, aud-prop_33f03864-8052-4dff-9613-1e8046450d16.xml, audio.synth_portparams, dmusprop/PSYNTH_PORTPARAMS, dmusprop/SYNTH_PORTPARAMS
dmusprop.h
Dmusprop.h
Windows
Windows
SYNTH_PORTPARAMS, *PSYNTH_PORTPARAMS
_SYNTH_PORTPARAMS
dmusprop/_SYNTH_PORTPARAMS
PSYNTH_PORTPARAMS
dmusprop/PSYNTH_PORTPARAMS
SYNTH_PORTPARAMS
dmusprop/SYNTH_PORTPARAMS
APIRef
kbSyntax
HeaderDef
dmusprop.h
_SYNTH_PORTPARAMS
PSYNTH_PORTPARAMS
SYNTH_PORTPARAMS

_SYNTH_PORTPARAMS structure

-description

The SYNTH_PORTPARAMS structure contains the configuration parameters for a DirectMusic port, which is a DirectMusic term for a device that sends or receives music data. (In KS terminology, a DirectMusic port does not correspond to a DMus port driver. It corresponds to a render or capture pin on a DirectMusic filter.)

-struct-fields

-field ValidParams

Specifies which of the SYNTH_PORTPARAMS structure members contain valid data. This member is a bitfield whose value is either zero or the bitwise OR of one or more of the following flag bits:

SYNTH_PORTPARAMS_VOICES

The Voices field is valid.

SYNTH_PORTPARAMS_CHANNELGROUPS

The ChannelGroups field is valid.

SYNTH_PORTPARAMS_AUDIOCHANNELS

The AudioChannels field is valid.

SYNTH_PORTPARAMS_SAMPLERATE

The SampleRate field is valid.

SYNTH_PORTPARAMS_EFFECT

The EffectsFlags flag is valid.

SYNTH_PORTPARAMS_SHARE

The Share field is valid.

-field Voices

Specifies the maximum number of simultaneous voices that the application wishes to play on this port.

-field ChannelGroups

Specifies the number of channel groups requested for this port. Each channel group contains 16 channels.

-field AudioChannels

Specifies the number of audio channels.

-field SampleRate

Specifies the number of samples per second for the audio data produced by the port.

-field EffectsFlags

Specifies the type of effects produced for audio output from this port. This member is a bitfield whose value is either zero or the bitwise OR of one or more of the following flag bits:

SYNTH_EFFECT_REVERB

Reverb is enabled.

SYNTH_EFFECT_CHORUS

Chorus effect is enabled.

SYNTH_EFFECT_DELAY

Delay effect is enabled.

If no effects are enabled, this member is set to SYNTH_EFFECT_NONE, which is zero.

-field Share

Specifies whether the port's channel groups are shared. When this member is TRUE, all ports use the channel groups assigned to this port. When this member is FALSE, the port is opened in exclusive mode and the use of the same channel groups by other ports is not allowed.

-remarks

A KSPROPERTY_SYNTH_PORTPARAMETERS get-property request uses the SYNTH_PORTPARAMS structure for both its property descriptor and its property value.

-see-also

KSPROPERTY_SYNTH_PORTPARAMETERS