BASS.NET API for the Un4seen BASS Audio Library

BassMidiBASS_MIDI_StreamGetMarks Method

BASS.NET API for the Un4seen BASS Audio Library
Retrieves the markers in a MIDI file stream.

Namespace:  Un4seen.Bass.AddOn.Midi
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax

public static BASS_MIDI_MARK[] BASS_MIDI_StreamGetMarks(
	int handle,
	int track,
	BASSMIDIMarker type
)

Parameters

handle
Type: SystemInt32
The MIDI stream to retrieve the markers from.
track
Type: SystemInt32
The track to get the markers from... 0 = 1st track, -1 = all tracks.
type
Type: Un4seen.Bass.AddOn.MidiBASSMIDIMarker
The type of marker to retrieve, one of the following (see BASSMIDIMarker):
BASS_MIDI_MARK_COPYCopyright notice events (MIDI meta event 2).
BASS_MIDI_MARK_CUECue events (MIDI meta event 07).
BASS_MIDI_MARK_INSTInstrument name events (MIDI meta event 4).
BASS_MIDI_MARK_KEYSIGKey signature events (MIDI meta event 89). The marker 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).
BASS_MIDI_MARK_LYRICLyric events (MIDI meta event 05).
BASS_MIDI_MARK_MARKERMarker events (MIDI meta event 06).
BASS_MIDI_MARK_TEXTText events (MIDI meta event 01).
BASS_MIDI_MARK_TIMESIGTime signature events (MIDI meta event 88). The marker 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.
BASS_MIDI_MARK_TRACKTrack name events (MIDI meta event 3).
BASS_MIDI_MARK_TRACKSTARTStart of a track in a standard MIDI format 2 file. The marker text is the track number (0 = the first).
BASS_MIDI_MARK_TICKFLAG: get position in ticks instead of bytes.

Return Value

Type: BASS_MIDI_MARK
On success, an array of BASS_MIDI_MARK instances is returned, else is returned. Use BASS_ErrorGetCode to get the error code.
Remarks

The markers are ordered chronologically, and by track number (lowest first) if multiple markers have the same position.

SYNCs can be used to be informed of when markers are encountered during playback.

If a lyric marker text begins with a / (slash) character, that means a new line should be started. If the text begins with a \ (backslash) character, the display should be cleared. Lyrics can sometimes be found in BASS_MIDI_MARK_TEXT instead of BASS_MIDI_MARK_LYRIC markers.

ERROR CODEDescription
BASS_ERROR_HANDLEhandle is not valid.
BASS_ERROR_ILLTYPEtype is not valid.
BASS_ERROR_ILLPARAMtrack is not valid.

See Also

Reference