Microsoft DirectX 8.1 (Visual Basic)

DirectMusicPerformance8.GetGrooveLevel

The 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

Parts

object

Resolves to a DirectMusicPerformance8 object.

mtTime

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

mtUntil

Variable of type Long that receives 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

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:

DMUS_E_NO_MASTER_CLOCK
DMUS_E_GET_UNSUPPORTED
DMUS_E_NOT_FOUND
DMUS_E_TRACK_NOT_FOUND

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