Microsoft DirectX 9.0

DMUS_DOWNLOADINFO

The DMUS_DOWNLOADINFO structure is used as a header for DLS data to be downloaded to a port. It defines the size and functionality of the download and is always followed by a DMUS_OFFSETTABLE chunk.

Syntax

typedef struct _DMUS_DOWNLOADINFO {
  DWORD dwDLType;
  DWORD dwDLId;
  DWORD dwNumOffsetTableEntries;
  DWORD cbSize;
} DMUS_DOWNLOADINFO;

Members

dwDLType

Type of data being downloaded. The following types are defined:

Value Description
DMUS_DOWNLOADINFO_INSTRUMENT Instrument definition, starting with the DMUS_INSTRUMENT structure.
DMUS_DOWNLOADINFO_INSTRUMENT2 Instrument definition supporting DLS level 2 articulation, starting with the DMUS_INSTRUMENT structure.
DMUS_DOWNLOADINFO_WAVE PCM waveform data, starting with the DMUS_WAVE structure.

dwDLId

Unique 32-bit identifier for the object. See Remarks.

dwNumOffsetTableEntries

Number of entries in the DMUS_OFFSETTABLE structure that follows.

cbSize

Total size of DMUS_DOWNLOADINFO, DMUS_OFFSETTABLE, and the actual data chunk.

Remarks

The identifier in dwDLId is used to connect objects and is obtained by using the IDirectMusicPortDownload8::GetDLId method. Primarily it connects the regions in an instrument to wave chunks. For example, if a download is given a dwDLId of 3, an instrument chunk downloads with the value 3 placed in the WaveLink.ulTableIndex member of one of its DMUS_REGION structures. This indicates that the region is connected to the wave chunk.

Requirements

  Header: Declared in dmdls.h.

See Also