DMUS_AUDIOPARAMS

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

DMUS_AUDIOPARAMS

The DMUS_AUDIOPARAMS structure describes required resources for the default synthesizer and buffers of a performance. It is passed to the IDirectMusicPerformance8::InitAudio method to request desired features and to receive information about what requests were granted.

Syntax

typedef struct _DMUS_AUDIOPARAMS {
  DWORD  dwSize;
  BOOL fInitNow;
  DWORD  dwValidData;
  DWORD  dwFeatures;
  DWORD  dwVoices;
  DWORD  dwSampleRate;
  CLSID  clsidDefaultSynth;
} DMUS_AUDIOPARAMS;

Members

dwSize

Size of the structure, in bytes. This member must be initialized to sizeof(DMUS_AUDIOPARAMS) before the structure is used.

fInitNow

Boolean value that specifies whether the sink and synthesizer are created immediately. If so, results are returned in this structure.

dwValidData

Flags that specify which members of this structure are valid. If fInitNow is TRUE when the structure is passed, this member receives flags that specify what members received data. The following values are defined.

Flag Description
DMUS_AUDIOPARAMS_FEATURES The dwFeatures member contains or has received data.
DMUS_AUDIOPARAMS_VOICES The dwVoices member contains or has received data.
DMUS_AUDIOPARAMS_SAMPLERATE The dwSampleRate member contains or has received data.
DMUS_AUDIOPARAMS_DEFAULTSYNTH The clsidDefaultSynth member contains or has received data. If this flag is not set, the Microsoft software synthesizer is the default synthesizer.

dwFeatures

Flags that specify required capabilities. The following values are defined.

Value Description
DMUS_AUDIOF_3D 3-D buffers. This flag is not implemented. Buffers in 3-D audiopaths always have 3-D capabilities.
DMUS_AUDIOF_ALL All features.
DMUS_AUDIOF_BUFFERS Multiple buffers.
DMUS_AUDIOF_DMOS Additional DMOs. This flag is not implemented.
DMUS_AUDIOF_ENVIRON Environmental modeling. This flag is not implemented.
DMUS_AUDIOF_EAX Support for Environmental Audio Extensions (EAX). This flag is not implemented.
DMUS_AUDIOF_STREAMING Support for streaming waveforms.

dwVoices

Number of voices. The default value is 64.

dwSampleRate

Sample rate of the sink and synthesizer, in the range from 11,025 to 96,000 kHz. The default value is 22,050.

clsidDefaultSynth

Class identifier of the default synthesizer. This is the synthesizer used by standard audiopaths and audiopaths created from configurations that request the default synthesizer.

Requirements

  Header: Declared in dmusici.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.