Class TickSender

The TickSender is used for sending MIDI clock messages out, so that other MIDI devices can stay in sync with a shimi metronome.

Hierarchy

  • TickSender

Implements

Constructors

constructor

Accessors

finished isFinished metronome midiOut ref ticksPerQuarterNote typeName

Methods

finish update withRef

Constructors

constructor

  • Parameters

    • metronome: IMetronome

      The metronome object which the TickSender sends out clock messages for.

    • midiOut: IMidiOut

      The midi out object which the TickSender sends clock messages to.

    • ticksPerQuarterNote: number = 24

      How many ticks occur per quarter note.

    Returns TickSender

Accessors

finished

isFinished

  • get isFinished(): boolean

  • Returns true if the TickSender has been instructed to stop everything by the finish() method.

    Returns boolean

metronome

  • get metronome(): IMetronome

  • The metronome object which the TickSender sends out clock messages for.

    Returns IMetronome

  • set metronome(value: IMetronome): void

  • Parameters

    Returns void

midiOut

  • get midiOut(): IMidiOut

  • The midi out object which the TickSender sends clock messages to.

    Returns IMidiOut

  • set midiOut(value: IMidiOut): void

  • Parameters

    Returns void

ref

  • get ref(): string

  • Provides a way of identifying tick senders so they can be easily retrieved later

    Returns string

  • set ref(value: string): void

  • Parameters

    • value: string

    Returns void

ticksPerQuarterNote

  • get ticksPerQuarterNote(): number

  • How many ticks occur per quarter note.

    Returns number

  • set ticksPerQuarterNote(value: number): void

  • Parameters

    • value: number

    Returns void

typeName

  • get typeName(): string

  • Returns the name of this type. This can be used rather than instanceof which is sometimes unreliable.

    Returns string

Methods

finish

  • Calling this tells the TickSender to stop whatever it's doing and that it will no longer be used.

    Returns void

update

  • This method is intended to be called by a clock to provide regular updates. It should be called by consumers of the library.

    Returns

    Parameters

    • msDelta: number

      How many milliseconds have passed since the last update cycle.

    Returns void

withRef

  • Provides a way for setting the ref through a chained function call. For example:

    clock.addChild(new TickSender(metronome, midiOut).withRef('ticksender'));

    Returns

    The calling object.

    Parameters

    • ref: string

      The ref to set on the object.

    Returns IClockChild

Settings

Member Visibility

Theme

Generated using TypeDoc