Class MML

This class manages instance of Part for playing MML (Music Macro Language).

Constructors

constructor

Methods

clear currentIndex getAllSequences getMML getMMLs getSequences getSyntaxTree has paused ready setup start stop toABC

Constructors

constructor

Methods

clear

  • clear(): MML

    This method clears instance of Part.

    Returns MML

    Return value is for method chain.

currentIndex

  • currentIndex(partNumber: number): number

    This method gets or sets current sequence index. This method is overloaded for type interface and type check.

    Parameters

    • partNumber: number

      This argument is part of MML.

    Returns number

    Return value is for current sequence index. Otherwise, Return value is for method chain.

  • currentIndex(partNumber: number, sequenceIndex: number): MML

    This method gets or sets current sequence index. This method is overloaded for type interface and type check.

    Parameters

    • partNumber: number

      This argument is part of MML.

    • sequenceIndex: number

      This argument is sequence index. If this argument is omitted, this method is getter for current sequence index.

    Returns MML

    Return value is for current sequence index. Otherwise, Return value is for method chain.

getAllSequences

  • getAllSequences(): Sequence[][]

    This method gets array that contains instance of Sequence from the all of MML parts.

    Returns Sequence[][]

getMML

  • getMML(index: number): string

    This method gets MML string.

    Parameters

    • index: number

      This argument selects MML part.

    Returns string

getMMLs

  • getMMLs(): string[]

    This method gets array that contains MML string.

    Returns string[]

getSequences

  • getSequences(index: number): Sequence[]

    This method gets array that contains instance of Sequence.

    Parameters

    • index: number

      This argument selects MML part.

    Returns Sequence[]

getSyntaxTree

  • getSyntaxTree(index: number): string

    This method gets string that represents MML syntax tree.

    Parameters

    • index: number

      This argument selects MML part.

    Returns string

has

  • has(): boolean

    This method determines whether sequences exist.

    Returns boolean

    If sequences exist, this value is true. Otherwise, this value is false.

paused

  • paused(): boolean

    This method determines whether MMLs are paused.

    Returns boolean

    If MMLs are paused, this value is true. Otherwise, this value is false.

ready

setup

  • setup(
        callbacks?: {
            endedCallback(): void;
            errorCallback(error: MMLSyntaxError): void;
            startCallback(sequence: Sequence, offset?: number): void;
            stopCallback(sequence: Sequence, offset?: number): void;
        },
    ): MML

    Parameters

    • Optionalcallbacks: {
          endedCallback(): void;
          errorCallback(error: MMLSyntaxError): void;
          startCallback(sequence: Sequence, offset?: number): void;
          stopCallback(sequence: Sequence, offset?: number): void;
      }

    Returns MML

start

  • start(partNumber: number, highlight?: boolean): MML

    This method starts designated MML part. Moreover, this method schedules next sequence.

    Parameters

    • partNumber: number

      This argument is part of MML.

    • Optionalhighlight: boolean

      This argument is true in case of surrounding by span.x-highlight HTML. The default value is false.

    Returns MML

    Return value is for method chain.

stop

  • stop(): MML

    This method stops the all of MML parts.

    Returns MML

    Return value is for method chain.

toABC

  • toABC(
        mml: string,
        X?: number,
        T?: string,
        M?: string,
        L?: string,
        K?: string,
    ): string

    This method converts MML to ABC Notation.

    Parameters

    • mml: string

      This argument is MML string.

    • OptionalX: number

      This argument is file number in ABC Notation.

    • OptionalT: string

      This argument is title in ABC Notation.

    • OptionalM: string

      This argument is beat in ABC Notation.

    • OptionalL: string

      This argument is note duration in ABC Notation.

    • OptionalK: string

      This argument is tone in ABC Notation.

    Returns string

    This is returned as ABC Notation.

Settings

Member Visibility

On This Page

Constructors
Methods