IDirectMusicPort::GetChannelPriority

The IDirectMusicPort::GetChannelPriority method is used to retrieve the priority of a MIDI channel. For an overview, see Channels.

HRESULT GetChannelPriority(
  DWORD   dwChannelGroup, 
  DWORD   dwChannel, 
  LPDWORD pdwPriority
);

Parameters

dwChannelGroup

Group that the channel is in.

dwChannel

Index of the channel on the group.

pdwPriority

Address of a variable to receive the priority ranking. See Remarks.

Return Values

If the method succeeds, the return value is S_OK.

Remarks

The following values, defined in Dmusicc.h, each represent a range of priorities. They are listed here in descending order of priority.

The following values express the default ranking of the channels within a range, according to the DLS Level 1 standard. They are listed here in descending order. Channel 10, the percussion channel, has the highest priority.

The priority of a channel is represented by a range plus an offset. For example, DAUD_STANDARD_VOICE_PRIORITY plus DAUD_CHAN10_DEF_VOICE_PRIORITY represents the highest priority within the standard range.

Channels that have the same priority value have equal priority, regardless of which channel group they belong to.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dmusicc.h.

See Also

IDirectMusicPort::SetChannelPriority