Skip to content

API Reference


API Reference / OfflineEngineOption

Type Alias: OfflineEngineOption ​

ts
type OfflineEngineOption = 
  | EngineName
  | {
  name: "peaks";
  lowpass?: LowpassOption;
};

Defined in: contract/types.ts:99

The offline engine option. Realtime peaks has a fixed lowpass inside analyzer.input, so only offline takes lowpass settings. The object form is peaks only, and takes name and lowpass only: any other key, such as restartAfterSeconds or a typo, makes the promise reject with a TypeError that names it, whatever its value. null or undefined means the default, tempogram.