XSound - v4.1.3
    Preparing search index...

    Interface Part

    This class starts and stops each MML part.

    interface Part {
        getCurrentIndex(): number;
        getMML(): string;
        getSequences(): Sequence[];
        getSyntaxTree(): string;
        has(): boolean;
        paused(): boolean;
        setCurrentIndex(index: number): void;
        start(highlight: boolean): void;
        stop(): void;
    }
    Index

    Methods

    getCurrentIndex getMML getSequences getSyntaxTree has paused setCurrentIndex start stop

    Methods

    • This method is getter for current sequence index.

      Returns number

    • This method is getter for MML string.

      Returns string

    • This method is getter for string that represents MML syntax tree.

      Returns string

    • This method determines whether sequence exists.

      Returns boolean

      If sequence exists, this value is true. Otherwise, this value is false.

    • This method determines whether MML part is paused.

      Returns boolean

      If MML part are paused, this value is true. Otherwise, this value is false.

    • This method is setter for current sequence index.

      Parameters

      • index: number

        This argument is new sequence index.

      Returns void

    • This method starts MML. Moreover, this method schedules next sequence.

      Parameters

      • highlight: boolean

        This argument is true in case of surrounding by span.x-highlight HTML.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods