Class MusicStream

constructor

• new MusicStream(timeSignature?: TimeSignature, bpm?: number): MusicStream

  Parameters

  • timeSignature: TimeSignature = TimeSignature.Common
  • bpm: number = 120

  Returns MusicStream

bpm

events

timeSignature

addEvent

• addEvent(notes: Note[], duration: Duration, velocity?: number): void

  Adds an event to the stream and advances the internal time cursor.

  Parameters

  • notes: Note[]
  • duration: Duration
  • velocity: number = 0.8

  Returns void

addEventAt

• addEventAt(
      time: number,
      notes: Note[],
      duration: Duration,
      velocity?: number,
  ): void

  Adds an event at a specific time without advancing the main cursor.

  Parameters

  • time: number
  • notes: Note[]
  • duration: Duration
  • velocity: number = 0.8

  Returns void

toJSON

• toJSON(): {
      events: {
          duration: number;
          notes: { frequency: number; name: string; stepsFromBase: number }[];
          time: number;
          velocity: number;
      }[];
      metadata: { bpm: number; timeSignature: string };
  }

  Generates a generic JSON representation of the stream. This is the standard contract for external engines.

  Returns {
      events: {
          duration: number;
          notes: { frequency: number; name: string; stepsFromBase: number }[];
          time: number;
          velocity: number;
      }[];
      metadata: { bpm: number; timeSignature: string };
  }

  • events: {
        duration: number;
        notes: { frequency: number; name: string; stepsFromBase: number }[];
        time: number;
        velocity: number;
    }[]

    The events, as in events.

  • metadata: { bpm: number; timeSignature: string }

    Meter and tempo.

    • bpm: number

      Tempo in beats per minute.

    • timeSignature: string

      Written time signature: '4/4', '3+2+2/8'.