Class Song

Namespace

ChartTools

Assembly

ChartTools.dll

Song playable in Clone Hero

public class Song

Inheritance

object

Song

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

PropertyMerger.Merge<T>(T, bool, bool, params T[])

TempoRescaler.Rescale(Song, float)

Properties

Formatting

Rules defined in song.ini that affect how the song data file is read and written

public FormattingRules Formatting { get; set; }

Property Value

FormattingRules

Remarks

Property summaries provided by Nathan Hurst.

GlobalEvents

List of events common to all instruments

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

Property Value

List<GlobalEvent>

Instruments

Set of all instruments

public InstrumentSet Instruments { get; set; }

Property Value

InstrumentSet

Metadata

Set of information about the song not unrelated to instruments, syncing or events

public Metadata? Metadata { get; set; }

Property Value

Metadata

SyncTrack

Set of markers that define the time signature and tempo

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?)

Reads all elements of a Song from a file.

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

Parameters

path string

Path of the file

config ReadingConfiguration

formatting FormattingRules

Rules defined in song.ini that affect how the song data file is read and written

Returns

Song

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

Reads all elements of a Song from a file asynchronously using multitasking.

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

Parameters

path string

Path of the file

config ChartReadingConfiguration

formatting FormattingRules

Rules defined in song.ini that affect how the song data file is read and written

cancellationToken CancellationToken

Token to request cancellation

Returns

Task<Song>

ToFile(string, WritingConfiguration?)

Writes the Song to a file.

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

Parameters

path string

config WritingConfiguration

Exceptions

ArgumentException

ArgumentNullException

PathTooLongException

DirectoryNotFoundException

LineException

UnauthorizedAccessException

NotSupportedException

SecurityException

ToFileAsync(string, WritingConfiguration?, CancellationToken)

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

Parameters

path string

config WritingConfiguration

cancellationToken CancellationToken

Returns

Task