createSongPlayer
@zylem/game-lib / audio / createSongPlayer
Function: createSongPlayer()
createSongPlayer(
definition,options?):SongPlayer
Defined in: packages/game-lib/src/lib/audio/song-player.ts:65
Plays a song on Tone.js's transport. The transport is shared, so creating
a player disposes the previous one: one song plays at a time. Tone.js is
loaded lazily; the first play() must follow a user gesture.
Parameters
definition
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?
SongPlayerOptions = \{\}