Callback delegates > CallbackForMidiMarkerEvents delegate

Remarks

Callback delegate invoked when a specific type of MIDI marker, previously enabled for notification, has been found inside the MIDI stream during playback: this callback can be set through a call to the CallbackForMidiMarkerEventsSet method.

Notifications of a specific MIDI marker can be enabled/disabled through the MIDI.MarkersEnableNotifications method.

The usage of this delegate is alternative to the MidiMarkerNotification event.

For further details about callback delegates see the How to synchronize the container application through callback delegates tutorial.

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 Delegate Sub CallbackForMidiMarkerEvents (

ByVal nMarkerType as enumMidiMarkerNotifications,

ByVal nPlayerIndex as Int16,

ByVal nTrack as Int32,

ByVal fPositionInMs as Double,

ByVal fPositionInTicks as Double,

ByVal fPositionInPercentage as Double,

ByVal pBufferUnicode as IntPtr,

ByVal nBufferLength as Int32

)

[C#]

public delegate void CallbackForMidiMarkerEvents (

enumMidiMarkerNotifications nMarkerType,

Int16 nPlayerIndex,

Int32 nTrack,

double fPositionInMs,

double fPositionInTicks,

double fPositionInPercentage,

IntPtr pBufferUnicode,

Int32 nBufferLength

)

[C++]

public delegate void CallbackForMidiMarkerEvents (

enumMidiMarkerNotifications nMarkerType,

Int16 nPlayerIndex,

Int32 nTrack,

double fPositionInMs,

double fPositionInTicks,

double fPositionInPercentage,

IntPtr pBufferUnicode,

Int32 nBufferLength

)

Parameter

Description

nMarkerType

Type of MIDI marker.

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).

nPlayerIndex

Zero-based index of the player reporting the event

nTrack

Number representing the zero-based index of the MIDI track. The total number of available MIDI tracks can be obtained through the MIDI:TrackCountGet method.

fPositionInMs

Position of the marker, expressed in milliseconds, inside the MIDI stream

fPositionInTicks

Position of the marker, expressed in MIDI ticks, inside the MIDI stream

fPositionInPercentage

Position of the marker, expressed in percentage, inside the MIDI stream

pBufferUnicode

Pointer to a buffer containing a string of Unicode characters with the text of the marker. Below a couple of snippets that show how to convert the buffer contents into a .NET string through marshaling:

Visual Basic .NET

Imports System.Runtime.InteropServices

Dim strInfo As String = Marshal.PtrToStringUni(pBufferUnicode, nBufferLength)

strInfo = strInfo.Trim()

Visual C#

using System.Runtime.InteropServices;

string strInfo = Marshal.PtrToStringUni(pBufferUnicode, nBufferLength);

strInfo = strInfo.Trim();

nBufferLength

The length in characters of the buffer above