alphaTab.midi.MidiFileGenerator

This generator creates a midi file using a score.

 class MidiFileGenerator

Properties

applyTranspositionPitches

Gets or sets whether transposition pitches should be applied to the individual midi events or not.

JavaScript

applyTranspositionPitches: boolean;

C#

bool ApplyTranspositionPitches { get; set; }

Kotlin

var applyTranspositionPitches: Boolean

ornamentKeysDown

For every note within the octave, the number of keys to go down when playing ornaments. This is typically only a key down.

Ornaments are not really a strictly defined element, alphaTab is using shipping some default.

JavaScript

static readonly ornamentKeysDown: number[];

C#

static IList<double> OrnamentKeysDown { get; }

Kotlin

companion object { val ornamentKeysDown: alphaTab.collections.DoubleList }

syncPoints

The computed sync points for synchronizing the midi file with an external backing track.

JavaScript

syncPoints: BackingTrackSyncPoint[];

C#

IList<BackingTrackSyncPoint> SyncPoints { get; set; }

Kotlin

var syncPoints: alphaTab.collections.List<BackingTrackSyncPoint>

tickLookup

Gets a lookup object which can be used to quickly find beats and bars at a given midi tick position.

JavaScript

readonly tickLookup: MidiTickLookup;

C#

MidiTickLookup TickLookup { get; }

Kotlin

val tickLookup: MidiTickLookup

transpositionPitches

Gets the transposition pitches for the individual midi channels.

JavaScript

readonly transpositionPitches: Map<number, number>;

C#

Map<double, double> TranspositionPitches { get; }

Kotlin

val transpositionPitches: alphaTab.collections.DoubleDoubleMap<Double, Double>

vibratoResolution

(no description)

JavaScript

vibratoResolution: number;

C#

double VibratoResolution { get; set; }

Kotlin

var vibratoResolution: Double

Methods

buildTranspositionPitches

(no description)

JavaScript

static buildTranspositionPitches(score: Score, settings: Settings): Map<number, number>

C#

static Map<double, double> BuildTranspositionPitches(Score score, Settings settings)

Kotlin

fun buildTranspositionPitches(score: Score, settings: Settings): alphaTab.collections.DoubleDoubleMap<Double, Double>

Parameter	Summary
scoreAll	(no description)
settingsAll	(no description)

generate

Starts the generation of the midi file.

JavaScript

generate(): void

C#

void Generate()

Kotlin

fun generate(): Unit

generateSingleBeat

(no description)

JavaScript

generateSingleBeat(beat: Beat): void

C#

void GenerateSingleBeat(Beat beat)

Kotlin

fun generateSingleBeat(beat: Beat): Unit

Parameter	Summary
beatAll	(no description)

generateSingleNote

(no description)

JavaScript

generateSingleNote(note: Note): void

C#

void GenerateSingleNote(Note note)

Kotlin

fun generateSingleNote(note: Note): Unit

Parameter	Summary
noteAll	(no description)

generateSyncPoints

Generates the sync points for the given score without re-generating the midi itself. Use this method if a re-generation of the sync points after modification is required. It correctly handles repeats and places sync points accoridng to their absolute midi tick when they need to be considered for synchronization.

JavaScript

static generateSyncPoints(score: Score, createNew?: boolean): BackingTrackSyncPoint[]

C#

static IList<BackingTrackSyncPoint> GenerateSyncPoints(Score score, bool? createNew)

Kotlin

fun generateSyncPoints(score: Score, createNew: Boolean?): alphaTab.collections.List<BackingTrackSyncPoint>

Parameter	Summary
scoreAll	The song for which to regenerate the sync points.
createNewAll	Whether a new set of sync points should be generated for the sync (start, stop and tempo changes).

Returns

The generated sync points for usage in the backing track playback.

getPitchWheel

Calculates the midi pitch wheel value for the give bend value.

JavaScript

static getPitchWheel(bendValue: number): number

C#

static double GetPitchWheel(double bendValue)

Kotlin

fun getPitchWheel(bendValue: Double): Double

Parameter	Summary
bendValueAll	(no description)

prepareSingleBeat

(no description)

JavaScript

prepareSingleBeat(beat: Beat): number

C#

double PrepareSingleBeat(Beat beat)

Kotlin

fun prepareSingleBeat(beat: Beat): Double

Parameter	Summary
beatAll	(no description)