tuneflow-plugin-basic/src/update_tempo_plugin.ts

Basic TuneFlow plugins

import { TempoEvent, TuneflowPlugin, WidgetType } from 'tuneflow';
import type { ParamDescriptor, Song } from 'tuneflow';

export class UpdateTempo extends TuneflowPlugin {
  static providerId(): string {
    return 'andantei';
  }

  static pluginId(): string {
    return 'update-tempo';
  }

  params(): { [paramName: string]: ParamDescriptor } {
    return {
      newTempo: {
        displayName: {
          zh: '曲速 (BPM)',
          en: 'Tempo (BPM)',
        },
        defaultValue: undefined,
        widget: {
          type: WidgetType.InputNumber,
        },
        hidden: true,
      },
      newTempoTick: {
        displayName: {
          zh: '位置',
          en: 'Position',
        },
        defaultValue: undefined,
        widget: {
          type: WidgetType.InputNumber,
        },
        hidden: true,
      },
      overwriteAll: {
        displayName: {
          zh: '覆盖所有曲速',
          en: 'Overwrite all tempos',
        },
        defaultValue: false,
        widget: {
          type: WidgetType.None,
        },
        hidden: true,
      },
    };
  }

  async run(song: Song, params: { [paramName: string]: any }): Promise<void> {
    const overwriteAll = this.getParam<boolean>(params, 'overwriteAll');
    const bpm = this.getParam<number>(params, 'newTempo');
    const tick = this.getParam<number>(params, 'newTempoTick');
    if (overwriteAll) {
      song.overwriteTempoChanges([
        new TempoEvent({
          ticks: tick,
          bpm,
          time: 0,
        }),
      ]);
    } else {
      song.updateTempoAtTick(tick, bpm);
    }
  }
}