renderSong
@zylem/game-lib / audio / renderSong
Function: renderSong()
renderSong(
song,options?):Promise<AudioBuffer>
Defined in: packages/game-lib/src/lib/audio/render.ts:21
Renders a song (or a subset of its tracks) to an AudioBuffer offline,
faster than real time. Pair with encodeWav to get a file. Works without
a user gesture: offline contexts do not need to be resumed.
Parameters
song
bpm
number = ...
clips
(\{ id: string; kind: "notes"; length: number; name?: string; notes: object[]; start: number; trackId: string; \} | \{ gain?: number; id: string; kind: "audio"; length: number; name?: string; offset?: number; start: number; trackId: string; url: string; \})[] = ...
id
string = ...
instruments
object[] = ...
lengthBars
number = ...
loop?
\{ enabled: boolean; end: number; start: number; \} = ...
loop.enabled
boolean = ...
loop.end
number = ...
loop.start
number = ...
Beats.
masterVolume?
number = ...
Master fader in dB.
name
string = ...
timeSignature
\{ denominator: number; numerator: number; \} = TimeSignatureSchema
timeSignature.denominator
number = ...
timeSignature.numerator
number = ...
tracks
object[] = ...
options?
RenderSongOptions = \{\}
Returns
Promise<AudioBuffer>