VocalPhrase

A range created by a vocals phrase marker, used during gameplay to decide which pitch/percussion notes and lyric syllables belong to the same sung line. The game scores and displays vocals phrase-by-phrase as playback crosses these ranges instead of treating every note as an unrelated standalone event. A phrase holds the notes and lyrics from its tick through its end tick, unless the next phrase starts on its end tick.

Properties

Property	Type	Description
`isPercussion`	`boolean`	Whether every note in this phrase is a vocals percussion cue.
`length`	`number`	Length of the vocal phrase, in ticks.
`lyrics`	`LyricEvent`[]	All lyric events contained inside this phrase range.
`msLength`	`number`	Length of the vocal phrase, in ms.
`msTime`	`number`	Time where the vocal phrase begins, in ms.
`notes`	`VocalNote`[]	All vocal note events contained inside this phrase range.
`player?`	`1` \| `2`	Lead-vocals singer assigned to this phrase in two-player modes; omitted for harmony phrases.
`tick`	`number`	Tick position where the vocal phrase begins.

scan-chart

scan-chart API

scan-chart/competitive API

Properties