Class Phrase

Namespace

ChartTools.Lyrics

Assembly

ChartTools.dll

Grouping of a PhraseMarker and set of VocalsNote for assembling lyric text.

public class Phrase : ILongTrackObject, ITrackObject, IReadOnlyTrackObject, ILongObject, IReadOnlyLongObject

Inheritance

object

Phrase

Implements

ILongTrackObject

ITrackObject

IReadOnlyTrackObject

ILongObject

IReadOnlyLongObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

TempoRescaler.Rescale(ILongObject, float)

TempoRescaler.Rescale(ILongTrackObject, float)

TempoRescaler.Rescale(ITrackObject, float)

Constructors

Phrase(PhraseMarker, IReadOnlyList<VocalsNote>?)

Grouping of a PhraseMarker and set of VocalsNote for assembling lyric text.

public Phrase(PhraseMarker marker, IReadOnlyList<VocalsNote>? notes = null)

Parameters

marker PhraseMarker

notes IReadOnlyList<VocalsNote>

Properties

DisplayedText

Phrase text assembled to its in-game appearance

public string DisplayedText { get; }

Property Value

string

Length

Manual length of the phrase defining a phrase end marker where applicable.

public uint Length { get; set; }

Property Value

uint

Remarks

A value of 0 defines the length to be up to the next phrase start.

Notes

Set of vocals notes containing the pitches and text for the phrase.

public IReadOnlyList<VocalsNote> Notes { get; }

Property Value

IReadOnlyList<VocalsNote>

PhraseMarker

Marker defining the position and length of the phrase.

public PhraseMarker PhraseMarker { get; }

Property Value

PhraseMarker

Position

Start position of the phrase

public uint Position { get; set; }

Property Value

uint

RawText

Concatenated raw text of all notes in the phrase, separated by spaces.

public string RawText { get; }

Property Value

string

Methods

ToGlobalEvents()

Converts the phrase to a set of global events representing the lyric data.

public IEnumerable<GlobalEvent> ToGlobalEvents()

Returns

IEnumerable<GlobalEvent>

Set of events generated during enumeration.