Project

interface Project {
name: string
bpm: number
timeSignature: TimeSignature
baseFrequency: number
duration: number
loop: LoopArea
meta: ProjectMeta
groove: GrooveShuffle
output: OutputAudioUnit
audioUnits: readonly AnyAudioUnit[]
instrumentUnits: readonly InstrumentAudioUnit<keyof Instruments>[]
auxUnits: readonly AuxAudioUnit[]
groupUnits: readonly GroupAudioUnit[]
markers: readonly Marker[]
tempoTrack: TempoTrack
signatureTrack: SignatureTrack
modulators: readonly AnyModulator[]
findAudioUnit(label: string): Nullable<AnyAudioUnit>
addInstrumentUnit<K extends keyof Instruments>(key: K, props?: AudioUnitProps, instrument?: DeepPartial<Instruments[K]>): InstrumentAudioUnit<K>
addAuxUnit(props?: BusAudioUnitProps): AuxAudioUnit
addGroupUnit(props?: BusAudioUnitProps): GroupAudioUnit
addMarker(props?: MarkerProps): Marker
addModulator<K extends keyof Modulators>(kind: K, props?: DeepPartial<Modulators[K]>): Modulators[K]
openInStudio(): void
mixdown(options?: MixdownOptions): Promise<AudioData>
}

A project under construction or the one open in the studio. Hand it back with Project.openInStudio

See:
- Api.getProject
- Api.newProject

Properties

`name: string`

Project name

`bpm: number`

Tempo in bpm (30 to 1000)

`timeSignature: TimeSignature`

Time signature. Assign an object or set its fields

See:
- TimeSignature

`baseFrequency: number`

Tuning reference in Hz (400 to 480, default 440)

`duration: number`

Project length in PPQN

`loop: LoopArea`

readonly

Loop range

See:
- LoopArea

`meta: ProjectMeta`

readonly

Project metadata

See:
- ProjectMeta

`groove: GrooveShuffle`

readonly

Global shuffle groove

See:
- GrooveShuffle

`output: OutputAudioUnit`

readonly

Primary output unit

See:
- OutputAudioUnit

`audioUnits: readonly AnyAudioUnit[]`

readonly

All units ordered by index

See:
- AnyAudioUnit

`instrumentUnits: readonly InstrumentAudioUnit<keyof Instruments>[]`

readonly

Instrument units

See:
- InstrumentAudioUnit
- Instruments

`auxUnits: readonly AuxAudioUnit[]`

readonly

Auxiliary (send effect) units

See:
- AuxAudioUnit

`groupUnits: readonly GroupAudioUnit[]`

readonly

Group (bus) units

See:
- GroupAudioUnit

`markers: readonly Marker[]`

readonly

Timeline markers sorted by position

See:
- Marker

`tempoTrack: TempoTrack`

readonly

Tempo automation

See:
- TempoTrack

`signatureTrack: SignatureTrack`

readonly

Time signature changes

See:
- SignatureTrack

`modulators: readonly AnyModulator[]`

readonly

All modulators ordered by index

See:
- AnyModulator

Methods

`findAudioUnit(label: string): Nullable<AnyAudioUnit>`

Find a unit by its label

Parameters

label (string)

Returns

Nullable<AnyAudioUnit>

`addInstrumentUnit< K extends keyof Instruments, >( key: K, props?: AudioUnitProps, instrument?: DeepPartial<Instruments[K]>, ): InstrumentAudioUnit<K>`

Add an instrument unit. It comes with one default track matching the instrument.

Type Parameters

K extends keyof Instruments

Parameters

key (K) — Instrument type
props (AudioUnitProps, optional) — Unit settings
instrument (DeepPartial<Instruments[K]>, optional) — Initial instrument parameters

Returns

InstrumentAudioUnit<K>

Example

CODE

const synth = project.addInstrumentUnit("Vaporisateur", {label: "Lead", volume: -6}, {cutoff: 2400, resonance: 0.4})

See:
- AudioUnitProps
- Instruments

`addAuxUnit(props?: BusAudioUnitProps): AuxAudioUnit`

Add an auxiliary (send effect) unit

Parameters

props (BusAudioUnitProps, optional)

Returns

AuxAudioUnit

See:
- BusAudioUnitProps

`addGroupUnit(props?: BusAudioUnitProps): GroupAudioUnit`

Add a group (bus) unit

Parameters

props (BusAudioUnitProps, optional)

Returns

GroupAudioUnit

See:
- BusAudioUnitProps

`addMarker(props?: MarkerProps): Marker`

Add a marker

Parameters

props (MarkerProps, optional)

Returns

Marker

See:
- MarkerProps

`addModulator< K extends keyof Modulators, >( kind: K, props?: DeepPartial<Modulators[K]>, ): Modulators[K]`

Add a modulator

Type Parameters

K extends keyof Modulators

Parameters

kind (K)
props (DeepPartial<Modulators[K]>, optional)

Returns

Modulators[K]

Example

CODE

const steps = project.addModulator("Steps", {count: 8, rateSync: 10})
steps.setSteps([1, 0, 0.5, 0, 1, 0, 0.5, 0.25])

See:
- Modulators

`openInStudio(): void`

Open the project in the studio (replaces the current project). Throws if the project is invalid

Returns

void

`mixdown(options?: MixdownOptions): Promise<AudioData>`

async

Render this project (including unapplied edits) to audio. Does not require openInStudio. Throws if the project is invalid

Parameters

options (MixdownOptions, optional)

Returns

Promise<AudioData>

Example

CODE

const audio = await project.mixdown()
await openDAW.saveFile(WavFile.encodeFloats(audio), `${project.name}.wav`, "audio/wav")

See:
- MixdownOptions