Class VocalsNote

Namespace

ChartTools.Lyrics

Assembly

ChartTools.dll

Note of a vocals track defining the pitch and displayed text of a single syllable.

public class VocalsNote : INote, ILongTrackObject, ITrackObject, IReadOnlyTrackObject, ILongObject, IReadOnlyLongObject

Inheritance

object

VocalsNote

Implements

INote

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

VocalsNote(uint, VocalsPitch, string?)

Note of a vocals track defining the pitch and displayed text of a single syllable.

public VocalsNote(uint position, VocalsPitch pitch, string? text = null)

Parameters

position uint

pitch VocalsPitch

text string

VocalsNote(uint, VocalsPitchValue, string?)

public VocalsNote(uint position, VocalsPitchValue pitch = VocalsPitchValue.None, string? text = null)

Parameters

position uint

pitch VocalsPitchValue

text string

Properties

DisplayedText

Syllable text formatted to its in-game appearance

public string DisplayedText { get; }

Property Value

string

Remarks

Some special characters may remain. See Vocals format documentation for more information.

Index

Numerical value of the note identity

public byte Index { get; set; }

Property Value

byte

IsWordEnd

true if is the last syllable or the only syllable of its word

public bool IsWordEnd { get; set; }

Property Value

bool

Length

Tick number on the track.

public uint Length { get; set; }

Property Value

uint

Remarks

A tick represents a subdivision of a beat. The number of subdivisions per beat is stored in Resolution.

Pitch

public VocalsPitch Pitch { get; set; }

Property Value

VocalsPitch

Position

Tick number on the track.

public uint Position { get; set; }

Property Value

uint

Remarks

A tick represents a subdivision of a beat. The number of subdivisions per beat is stored in Resolution.

RawText

Raw text data of the syllable

public string RawText { get; set; }

Property Value

string