Class Part

This class starts and stops each MML part.

Index

Constructors

Methods

getCurrentIndex getMML getSequences getSyntaxTree has paused setCurrentIndex start stop

Constructors

constructor

new Part(
    params: {
        mml: string;
        offset?: number;
        source: OscillatorModule | OneshotModule | NoiseModule;
        endedCallback(): void;
        errorCallback(error: MMLSyntaxError): void;
        startCallback(sequence: Sequence, offset?: number): void;
        stopCallback(sequence: Sequence, offset?: number): void;
    },
): Part
Parameters
- params: {
      mml: string;
      offset?: number;
      source: OscillatorModule | OneshotModule | NoiseModule;
      endedCallback(): void;
      errorCallback(error: MMLSyntaxError): void;
      startCallback(sequence: Sequence, offset?: number): void;
      stopCallback(sequence: Sequence, offset?: number): void;
  }
Returns Part
- Defined in MML/Part.ts:46

Methods

getCurrentIndex

getCurrentIndex(): number
This method is getter for current sequence index.

Returns number
- Defined in MML/Part.ts:284

getMML

getMML(): string
This method is getter for MML string.

Returns string
- Defined in MML/Part.ts:247

getSequences

getSequences(): Sequence[]
This method is getter for array that contains sequence.

Returns Sequence[]
- Defined in MML/Part.ts:254

getSyntaxTree

getSyntaxTree(): string
This method is getter for string that represents MML syntax tree.

Returns string
- Defined in MML/Part.ts:261

has

has(): boolean
This method determines whether sequence exists.

Returns boolean
If sequence exists, this value is true. Otherwise, this value is false.
- Defined in MML/Part.ts:269

paused

paused(): boolean
This method determines whether MML part is paused.

Returns boolean
If MML part are paused, this value is true. Otherwise, this value is false.
- Defined in MML/Part.ts:277

setCurrentIndex

setCurrentIndex(index: number): void
This method is setter for current sequence index.
Parameters
- index: number
  This argument is new sequence index.
Returns void
- Defined in MML/Part.ts:292

start

start(highlight: boolean): 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
- Defined in MML/Part.ts:107

stop

stop(): void
This method stops MML.

Returns void
- Defined in MML/Part.ts:204