Class PhraseExtensions

Namespace

ChartTools.Lyrics

Assembly

ChartTools.dll

Provides additional methods to Phrase.

public static class PhraseExtensions

Inheritance

object

PhraseExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetLyrics(StandardVocalsTrack)

public static IEnumerable<Phrase> GetLyrics(this StandardVocalsTrack track)

Parameters

track StandardVocalsTrack

Returns

IEnumerable<Phrase>

GetLyrics(IEnumerable<GlobalEvent>)

Wraps lyrics-related global events into a set of grouped phrases for easier handling.

public static IEnumerable<Phrase> GetLyrics(this IEnumerable<GlobalEvent> events)

Parameters

events IEnumerable<GlobalEvent>

Set of events

Returns

IEnumerable<Phrase>

GetLyrics(IEnumerable<GlobalEvent>, out IList<PhraseMarker>, out IList<VocalsNote>)

public static void GetLyrics(this IEnumerable<GlobalEvent> events, out IList<PhraseMarker> phrases, out IList<VocalsNote> notes)

Parameters

events IEnumerable<GlobalEvent>

phrases IList<PhraseMarker>

notes IList<VocalsNote>

GetLyrics(IEnumerable<PhraseMarker>, IEnumerable<VocalsNote>)

public static IEnumerable<Phrase> GetLyrics(IEnumerable<PhraseMarker> phrases, IEnumerable<VocalsNote> notes)

Parameters

phrases IEnumerable<PhraseMarker>

notes IEnumerable<VocalsNote>

Returns

IEnumerable<Phrase>

SetLyrics(IEnumerable<GlobalEvent>, StandardVocalsTrack)

Generates a new set of global events where lyric-related events are replaced with ones matching a vocals track.

public static IEnumerable<GlobalEvent> SetLyrics(this IEnumerable<GlobalEvent> events, StandardVocalsTrack track)

Parameters

events IEnumerable<GlobalEvent>

Original set of events

track StandardVocalsTrack

Vocals track containing the new lyric data

Returns

IEnumerable<GlobalEvent>

New set of events generated during enumeration.

Remarks

Non-lyric events are maintained object-wise across the old and new set.

SetLyrics(IEnumerable<GlobalEvent>, IEnumerable<PhraseMarker>, IEnumerable<VocalsNote>)

public static IEnumerable<GlobalEvent> SetLyrics(this IEnumerable<GlobalEvent> events, IEnumerable<PhraseMarker> markers, IEnumerable<VocalsNote> notes)

Parameters

events IEnumerable<GlobalEvent>

markers IEnumerable<PhraseMarker>

notes IEnumerable<VocalsNote>

Returns

IEnumerable<GlobalEvent>

SetLyrics(IEnumerable<GlobalEvent>, IEnumerable<Phrase>)

Generates a new set of global events where lyric-related events are replaced with ones matching a set of phrases.

public static IEnumerable<GlobalEvent> SetLyrics(this IEnumerable<GlobalEvent> events, IEnumerable<Phrase> phrases)

Parameters

events IEnumerable<GlobalEvent>

Original set of events

phrases IEnumerable<Phrase>

Phrases containing the new lyric data

Returns

IEnumerable<GlobalEvent>

New set of events generated during enumeration.

Remarks

Non-lyric events are maintained object-wise across the old and new set.

ToGlobalEvents(IEnumerable<PhraseMarker>, IEnumerable<VocalsNote>)

public static IEnumerable<GlobalEvent> ToGlobalEvents(IEnumerable<PhraseMarker> markers, IEnumerable<VocalsNote> notes)

Parameters

markers IEnumerable<PhraseMarker>

notes IEnumerable<VocalsNote>

Returns

IEnumerable<GlobalEvent>

ToGlobalEvents(IEnumerable<Phrase>)

Converts a set of Phrase to a set of GlobalEvent making up the phrases.

public static IEnumerable<GlobalEvent> ToGlobalEvents(this IEnumerable<Phrase> source)

Parameters

source IEnumerable<Phrase>

Phrases to convert into global events

Returns

IEnumerable<GlobalEvent>

Global events making up the phrases