DirectMusicPerformance.GetGrooveLevel

The DirectMusicPerformance.GetGrooveLevel method retrieves the groove level from the performance's control segment. The groove level determines which patterns can be played at the specified time.

object.GetGrooveLevel(mtTime As Long, _
    mtUntil As Long) As Byte

Parameters

object

Object expression that resolves to a DirectMusicPerformance object.

mtTime

Time for which the groove level is to be retrieved, in music time.

mtUntil

Variable to receive the music time (relative to mtTime) until which the groove level is valid. If this returns a value of 0, either the groove level is always valid, or it is unknown when it might become invalid. See Remarks.

Return Values

If the method succeeds, it returns a value in the range from 1 through 100.

Error Codes

If the method fails, it raises an error, and Err.Number can be set to one of the following error codes:

Remarks

Normally, the primary segment is the control segment. However, a secondary segment can be designated as a control segment when it is played. The object returned by the method can become invalid before the time returned in mtUntil if another control segment is cued.

See Also

CONST_DMUS_SEGF_FLAGS