Class Song

Namespace

ChartTools

Assembly

ChartTools.dll

public class Song

Inheritance

object

Song

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

TempoRescaler.Rescale(Song, float)

TempoRescaler.Rescale<TChord, TNote, TLane>(TChord, float)

Constructors

Song()

public Song()

Properties

Formatting

public FormattingRules Formatting { get; set; }

Property Value

FormattingRules

GlobalEvents

public List<GlobalEvent>? GlobalEvents { get; set; }

Property Value

List<GlobalEvent>

Instruments

public InstrumentSet Instruments { get; set; }

Property Value

InstrumentSet

Metadata

public Metadata? Metadata { get; set; }

Property Value

Metadata

SyncTrack

public SyncTrack? SyncTrack { get; set; }

Property Value

SyncTrack

UnknownChartSections

public ChartSection? UnknownChartSections { get; set; }

Property Value

ChartSection

Vocals

public Vocals? Vocals { get; set; }

Property Value

Vocals

Methods

FromDirectory(string, ReadingConfiguration?)

public static Song FromDirectory(string directory, ReadingConfiguration? config = null)

Parameters

directory string

config ReadingConfiguration

Returns

Song

FromDirectoryAsync(string, ReadingConfiguration?, CancellationToken)

public static Task<Song> FromDirectoryAsync(string directory, ReadingConfiguration? config = null, CancellationToken cancellationToken = default)

Parameters

directory string

config ReadingConfiguration

cancellationToken CancellationToken

Returns

Task<Song>

FromFile(string, ReadingConfiguration?, FormattingRules?)

public static Song FromFile(string path, ReadingConfiguration? config = null, FormattingRules? formatting = null)

Parameters

path string

config ReadingConfiguration

formatting FormattingRules

Returns

Song

FromFileAsync(string, ChartReadingConfiguration?, FormattingRules?, CancellationToken)

public static Task<Song> FromFileAsync(string path, ChartReadingConfiguration? config = null, FormattingRules? formatting = null, CancellationToken cancellationToken = default)

Parameters

path string

config ChartReadingConfiguration

formatting FormattingRules

cancellationToken CancellationToken

Returns

Task<Song>

ToFile(string, WritingConfiguration?, FormattingRules?)

public void ToFile(string path, WritingConfiguration? config = null, FormattingRules? formatting = null)

Parameters

path string

config WritingConfiguration

formatting FormattingRules

ToFileAsync(string, WritingConfiguration?, FormattingRules?, CancellationToken)

public Task ToFileAsync(string path, WritingConfiguration? config = null, FormattingRules? formatting = null, CancellationToken cancellationToken = default)

Parameters

path string

config WritingConfiguration

formatting FormattingRules

cancellationToken CancellationToken

Returns

Task