XSound - v4.2.1
    Preparing search index...

    Interface MML

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

    interface MML {
        clear(): MML;
        currentIndex(partNumber: number): number;
        currentIndex(partNumber: number, sequenceIndex: number): MML;
        getAllSequences(): Sequence[][];
        getMML(index: number): string;
        getMMLs(): string[];
        getSequences(index: number): Sequence[];
        getSyntaxTree(index: number): string;
        has(): boolean;
        paused(): boolean;
        ready(
            params: {
                mmls: string[];
                offset?: number;
                source: OscillatorModule | OneshotModule | NoiseModule;
            },
        ): MML;
        setup(
            callbacks?: {
                endedCallback?(): void;
                errorCallback?(error: MMLSyntaxError): void;
                startCallback?(sequence: Sequence, offset?: number): void;
                stopCallback?(sequence: Sequence, offset?: number): void;
            },
        ): MML;
        start(partNumber: number, highlight?: boolean): MML;
        stop(): MML;
        toABC(
            mml: string,
            X?: number,
            T?: string,
            M?: string,
            L?: string,
            K?: string,
        ): string;
    }
    Index

    Methods

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

    Methods

    • This method clears instance of Part.

      Returns MML

      Return value is for method chain.

    • 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.

    • 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.

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

      Returns Sequence[][]

    • This method gets MML string.

      Parameters

      • index: number

        This argument selects MML part.

      Returns string

    • This method gets array that contains MML string.

      Returns string[]

    • This method gets array that contains instance of Sequence.

      Parameters

      • index: number

        This argument selects MML part.

      Returns Sequence[]

    • This method gets string that represents MML syntax tree.

      Parameters

      • index: number

        This argument selects MML part.

      Returns string

    • This method determines whether sequences exist.

      Returns boolean

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

    • This method determines whether MMLs are paused.

      Returns boolean

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

    • Parameters

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

      Returns 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.

    • This method stops the all of MML parts.

      Returns MML

      Return value is for method chain.

    • 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

    Methods