Class Track

constructor

• new Track(): Track

• Returns Track

data

events

explicitTickEvents

size

tickPointer

type

addCopyright

• addCopyright(text): Track

• Adds copyright to MIDI file.

  Parameters

  • text: string

    Text of copyright line.

  Returns Track

addCuePoint

• addCuePoint(text): Track

• Adds cue point to MIDI file.

  Parameters

  • text: string

    Text of cue point.

  Returns Track

addEvent

• addEvent(events, mapFunction?): Track

• Adds any event type to the track. Events without a specific startTick property are assumed to be added in order of how they should output. Events with a specific startTick property are set aside for now will be merged in during build process.

  TODO: Don't put startTick events in their own array. Just lump everything together and sort it out during buildData();

  Parameters

  • events: AbstractEvent | AbstractEvent[]

    Event object or array of Event objects.

  • Optional mapFunction: ((i, event) => object)

    Callback which can be used to apply specific properties to all events.

    • • (i, event): object

      • Parameters

        • i: number

        • event: AbstractEvent

        Returns object

  Returns Track

addInstrumentName

• addInstrumentName(text): Track

• Sets instrument name of track.

  Parameters

  • text: string

    Name of instrument.

  Returns Track

addLyric

• addLyric(text): Track

• Adds lyric to MIDI file.

  Parameters

  • text: string

    Lyric text to add.

  Returns Track

addMarker

• addMarker(text): Track

• Adds marker to MIDI file.

  Parameters

  • text: string

    Marker text.

  Returns Track

addText

• addText(text): Track

• Adds text to MIDI file.

  Parameters

  • text: string

    Text to add.

  Returns Track

addTrackName

• addTrackName(text): Track

• Adds Sequence/Track Name.

  Parameters

  • text: string

    Text of track name.

  Returns Track

buildData

• buildData(options?): Track

• Builds int array of all events.

  Parameters

  • options: {} = {}

  Returns Track

controllerChange

• controllerChange(number, value, channel?, delta?): Track

• Adds a controller change event

  Parameters

  • number: number

    Control number.

  • value: number

    Control value.

  • Optional channel: number

    Channel to send controller change event on (1-based).

  • Optional delta: number

    Track tick offset for cc event.

  Returns Track

mergeExplicitTickEvents

• mergeExplicitTickEvents(): void

• Returns void

mergeSingleEvent

• mergeSingleEvent(event): Track

• Merges a single event into this track's list of events based on event.tick property.

  Parameters

  • event: AbstractEvent

  Returns Track

mergeTrack

• mergeTrack(track): Track

• Merges another track's events with this track.

  Parameters

  • track: Track

  Returns Track

polyModeOn

• polyModeOn(): Track

• Channel mode messages

  Returns Track

removeEventsByName

• removeEventsByName(eventName): Track

• Removes all events matching specified type.

  Parameters

  • eventName: string

    Event type

  Returns Track

setKeySignature

• setKeySignature(sf, mi): Track

• Sets key signature.

  Parameters

  • sf: any

  • mi: any

  Returns Track

setPitchBend

• setPitchBend(bend): Track

• Sets a pitch bend.

  Parameters

  • bend: number

    Bend value ranging [-1,1], zero meaning no bend.

  Returns Track

setTempo

• setTempo(bpm, tick?): Track

• Sets tempo of the MIDI file.

  Parameters

  • bpm: number

    Tempo in beats per minute.

  • tick: number = 0

    Start tick.

  Returns Track

setTimeSignature

• setTimeSignature(numerator, denominator, midiclockspertick, notespermidiclock): Track

• Sets time signature.

  Parameters

  • numerator: number

    Top number of the time signature.

  • denominator: number

    Bottom number of the time signature.

  • midiclockspertick: number

    Defaults to 24.

  • notespermidiclock: number

    Defaults to 8.

  Returns Track