| Microsoft DirectX 8.1 (Visual Basic) |
The members of the CONST_DMUS_SEGF_FLAGS enumeration are used in various methods of the DirectMusicPerformance8 object to control the timing and other aspects of actions on a segment.
Syntax
Enum CONST_DMUS_SEGF_FLAGS
DMUS_SEGF_AFTERLATENCYTIME = 4194304 (&H400000)
DMUS_SEGF_AFTERPREPARETIME = 1024 (&H400)
DMUS_SEGF_AFTERQUEUETIME = 2097152 (&H200000)
DMUS_SEGF_ALIGN = 65536 (&H10000)
DMUS_SEGF_AUTOTRANSITION = 1048576 (&H100000)
DMUS_SEGF_BEAT = 4096 (&H1000)
DMUS_SEGF_CONTROL = 512 (&H200)
DMUS_SEGF_DEFAULT = 16384 (&H4000)
DMUS_SEGF_GRID = 2048 (&H800)
DMUS_SEGF_MARKER = 16777216 (&H1000000)
DMUS_SEGF_MEASURE = 8192 (&H2000)
DMUS_SEGF_NOINVALIDATE = 32768 (&H8000)
DMUS_SEGF_QUEUE = 256 (&H100)
DMUS_SEGF_REFTIME = 64 (&H40)
DMUS_SEGF_SECONDARY = 128 (&H80)
DMUS_SEGF_SEGMENTEND = 8388608 (&H800000)
DMUS_SEGF_TIMESIG_ALWAYS = 33554432 (&H2000000)
DMUS_SEGF_USE_AUDIOPATH = 67108864 (&H4000000)
DMUS_SEGF_VALID_START_BEAT = 131072 (&H20000)
DMUS_SEGF_VALID_START_GRID = 262144 (&H40000)
DMUS_SEGF_VALID_START_MEASURE = 134217728 (&H8000000
DMUS_SEGF_VALID_START_TICK = 524288 (&H80000)
End Enum
Constants
DMUS_SEGF_AFTERLATENCYTIME
Play after the latency time. Because this is true for all segments, this flag currently has no effect.
DMUS_SEGF_AFTERPREPARETIME
Play after the Prepare Time.
DMUS_SEGF_AFTERQUEUETIME
Play after the queue time. This is the default for primary segments. Ignored if DMUS_SEGF_AFTERPREPARETIME is also set.
DMUS_SEGF_ALIGN
The beginning of the segment can be aligned with a boundary, such as measure or beat, that has already passed. For this to happen, the segment must have a valid start point that falls before the next boundary. Start points can be defined in the segment, or one of the DMUS_SEGF_VALID_START_xxx flags can be used to define the granularity of valid start points. Any DMUS_SEGF_VALID_START_xxx flag takes effect only if a valid start point is not defined in the segment.
DMUS_SEGF_AUTOTRANSITION
Compose and play a transition segment, using the transition template.
DMUS_SEGF_BEAT
Play on a beat boundary.
DMUS_SEGF_CONTROL
Play as a control segment (secondary segments only). See Remarks.
DMUS_SEGF_DEFAULT
Use segment's default boundary.
DMUS_SEGF_GRID
Play on a grid boundary.
DMUS_SEGF_MARKER
Play at next marker in the primary segment. If there are no markers, use other resolution flags.
DMUS_SEGF_MEASURE
Play on a measure boundary.
DMUS_SEGF_NOINVALIDATE
Setting this flag in DirectMusicPerformance8.PlaySegmentEx for a primary or control segment causes the new segment not to cause an invalidation. Without this flag, an invalidation occurs, cutting off and resetting any currently playing curve or note. This flag should be combined with DMUS_SEGF_AFTERPREPARETIME so that notes in the new segment do not play over notes played by the old segment.
DMUS_SEGF_QUEUE
For a primary segment, play at the end of the primary segment queue. For a secondary segment, play at the end of the secondary segment specified in the pFrom parameter of DirectMusicPerformance8.PlaySegmentEx.
DMUS_SEGF_REFTIME
Time parameter is in clock time.
DMUS_SEGF_SECONDARY
Secondary segment.
DMUS_SEGF_SEGMENTEND
Play at the end of the primary segment that is playing at the start time. If the new segment is being played as a primary segment, any primary segments already queued after the currently playing primary segment are flushed. If no primary segment is playing, use other resolution flags. When combined with DMUS_SEGF_ALIGN, this flag causes the beginning of the cued segment to be aligned with the beginning of the current primary segment.
DMUS_SEGF_TIMESIG_ALWAYS
Align start time with current time signature, even if there is no primary segment.
DMUS_SEGF_USE_AUDIOPATH
Use the audiopath embedded in the segment. Automatic downloading of bands must be enabled to ensure that the sounds play correctly.
DMUS_SEGF_VALID_START_BEAT
Allow the start to occur on any beat. Used in combination with DMUS_SEGF_ALIGN.
DMUS_SEGF_VALID_START_GRID
Allow the start to occur on any grid. Used in combination with DMUS_SEGF_ALIGN.
DMUS_SEGF_VALID_START_MEASURE
Allow the start to occur on any measure. Used in combination with DMUS_SEGF_ALIGN.
DMUS_SEGF_VALID_START_TICK
Allow the start to occur any time. Used in combination with DMUS_SEGF_ALIGN.
Remarks
Normally the primary segment is the control segment. The DMUS_SEGF_CONTROL flag can be used to make a secondary segment the control segment. There should be only one control segment at a time. (Although it is possible to create multiple control segments, there is no guarantee of which one will actually be used by DirectMusic as the control segment.) By default, only the control segment sends tempo messages.
If the DMUS_SEGF_CONTROL flag is set, DMUS_SEGF_SECONDARY is assumed.
No more than one flag from each of the following groups should be specified.
Boundary
This flag controls the point in the currently playing primary segment at which the start point of the cued segment falls. It can be combined with DMUS_SEGF_MARKER, in which case the boundary flag will be used only if no marker exists in the primary segment.
DMUS_SEGF_BEAT
DMUS_SEGF_DEFAULT
DMUS_SEGF_GRID
DMUS_SEGF_MEASURE
DMUS_SEGF_QUEUE
DMUS_SEGF_SEGMENTEND
Alignment
This flag controls the segment start time of the cued segment, when its play time falls in the past. It must be combined with DMUS_SEGF_ALIGN.
DMUS_SEGF_VALID_START_BEAT
DMUS_SEGF_VALID_START_GRID
DMUS_SEGF_VALID_START_MEASURE
DMUS_SEGF_VALID_START_TICK
It is possible to combine one flag from each group. For example, combining DMUS_SEGF_MEASURE with DMUS_SEGF_ALIGN and DMUS_SEGF_VALID_START_BEAT causes the start point of the cued segment to fall at a measure boundary in the current primary segment. If this boundary has already passed, the cued segment starts playing at the next beat boundary within itself that is not aligned to a past time. For more information, see Segment Timing.
See Also