DMUS_TRACKF_FLAGS

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

DMUS_TRACKF_FLAGS

The DMUS_TRACKF_FLAGS enumerated type is used in the dwFlags parameter of the IDirectMusicTrack8::Play and IDirectMusicTrack8::PlayEx methods.

Syntax

typedef enum enumDMUS_TRACKF_FLAGS {
  DMUS_TRACKF_SEEK   = 1,
  DMUS_TRACKF_LOOP   = 2,
  DMUS_TRACKF_START  = 4,
  DMUS_TRACKF_FLUSH  = 8,
  DMUS_TRACKF_DIRTY  = 0x10,
  DMUS_TRACKF_NOTIFY_OFF = 0x20,
  DMUS_TRACKF_PLAYOFF  = 0x40,
  DMUS_TRACKF_LOOPEND  = 0x80,
  DMUS_TRACKF_STOP   = 0x100,
  DMUS_TRACKF_RECOMPOSE  = 0x200,
  DMUS_TRACKF_CLOCK  = 0x400,
} DMUS_TRACKF_FLAGS;

Constants

DMUS_TRACKF_SEEK

IDirectMusicTrack8::Play was called in response to seeking, meaning that the mtStart parameter is not necessarily the same as the mtEnd of the previous call.

DMUS_TRACKF_LOOP

Play was called in response to a loop.

DMUS_TRACKF_START

This is the first call to IDirectMusicTrack8::Play. DMUS_TRACKF_SEEK can also be set if the track is not playing from the beginning.

DMUS_TRACKF_FLUSH

Play was called in response to a flush or invalidation that requires the track to replay something that it played previously. In this case, DMUS_TRACKF_SEEK is set, as well.

DMUS_TRACKF_DIRTY

A control segment has begun or ended. Tracks that normally wait until mtNext to call IDirectMusicTrack8::GetParam or IDirectMusicTrack8::GetParamEx should make the call right away, instead of waiting, because their data might now be invalid. For more information on setting control segments, see DMUS_SEGF_FLAGS.

DMUS_TRACKF_NOTIFY_OFF

Track is not to send notifications.

DMUS_TRACKF_PLAYOFF

Track is not to play, but can still send notifications.

DMUS_TRACKF_LOOPEND

End of range is also a loop end.

DMUS_TRACKF_STOP

End of range is also end of playing this segment.

DMUS_TRACKF_RECOMPOSE

Track should be recomposed on each loop. A signpost track is recomposed using a different chord progression, and a melody formulation track is recomposed using different melody fragments.

DMUS_TRACKF_CLOCK

Time parameters are in reference time. Valid only for IDirectMusicTrack8::PlayEx.

Remarks

When Play is called in response to a repeat, DMUS_TRACKF_LOOP and DMUS_TRACKF_SEEK are set.

To support invalidation, tracks must support seeking..

Requirements

  Header: Declared in dmplugin.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.