IDirectMusicPort8::GetChannelPriority

The GetChannelPriority method retrieves the priority of a MIDI channel. For an overview, see Channels.

Syntax

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 that receives the priority ranking. See Remarks.

Return Values

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 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_HIGH_VOICE_PRIORITY combined with DAUD_CHAN10_VOICE_PRIORITY_OFFSET represents the highest priority within the high range. Combined range and offset values for the standard range are defined for convenience in Dmusicc.h as DAUD_CHAN1_DEF_VOICE_PRIORITY, .DAUD_CHAN2_DEF_VOICE_PRIORITY, and so on.

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

Requirements

  Header: Dmusicc.h

See Also

• IDirectMusicPort8 Interface
• IDirectMusicPort8::SetChannelPriority