Copyright © 2005-2019 MultiMedia Soft

MIDI.MarkersEnum method

Previous pageReturn to chapter overviewNext page

Remarks

 

Enumerates a specific type of marker detected inside the loaded MIDI stream. After completing the enumeration, information about each of the detected markers can be obtained through the MIDI.MarkersEnumItemGet method.

 

For further details about the use of MIDI protocol see the MIDIMan class section and the How to deal with MIDI protocol tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function MarkersEnum (

nPlayerIndex as Int16,

nMarkerType as enumMidiMarkerNotifications,

ByRef nCount as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes MarkersEnum (

Int16 nPlayerIndex,

enumMidiMarkerNotifications nMarkerType,

ref Int32 nCount

);


 

[C++]

public: enumErrorCodes MarkersEnum (

Int16 nPlayerIndex,

enumMidiMarkerNotifications nMarkerType,

Int32 __gc *nCount

);


 

 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

nMarkerType

Type of marker whose notification for which there is an interest.

Supported values are the following:

Mnemonic constant

Value

Meaning

MIDI_NOTIFICATION_LYRIC

0

Lyrics (MIDI meta event 5)

MIDI_NOTIFICATION_TEXT

1

Text (MIDI meta event 1)

MIDI_NOTIFICATION_MARKER

2

Marker (MIDI meta event 6)

MIDI_NOTIFICATION_CUE

3

Cue point (MIDI meta event 7)

MIDI_NOTIFICATION_TIME_SIGNATURE

4

Time signature (MIDI meta event 88). The reported text is in the form of "a b", where a is the number of sharps, if positive, or flats, if negative, and b signifies major, if 0, or minor, if 1.

MIDI_NOTIFICATION_KEY_SIGNATURE

5

Key signature (MIDI meta event 89). The reported text is in the form of "a/b c d", where a is the numerator, b is the denominator, c is the metronome pulse and d is the number of 32nd notes per MIDI quarter-note.

MIDI_NOTIFICATION_COPYRIGHT

6

Copyright notice (MIDI meta event 2).

MIDI_NOTIFICATION_TRACK

7

Track name (MIDI meta event 3).

MIDI_NOTIFICATION_INSTRUMENT

8

Instrument name (MIDI meta event 4).

nCount

Reference that, on return from the method call, will contain the number of markers of the given type detected inside the loaded MIDI stream.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.