Class ChartFile

Namespace

ChartTools.IO.Chart

Assembly

ChartTools.dll

Provides methods for reading and writing chart files

public static class ChartFile

Inheritance

object

ChartFile

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DefaultReadConfig

Default configuration to use for reading when the provided configuration is default

public static ChartReadingConfiguration DefaultReadConfig { get; set; }

Property Value

ChartReadingConfiguration

DefaultWriteConfig

Default configuration to use for writing when the provided configuration is default

public static ChartWritingConfiguration DefaultWriteConfig { get; set; }

Property Value

ChartWritingConfiguration

Methods

ReadComponents(ReadingDataSource, ComponentList, ChartReadingConfiguration?)

Reads a a set of Song components from a chart target.

public static Song ReadComponents(ReadingDataSource source, ComponentList components, ChartReadingConfiguration? config = null)

Parameters

source ReadingDataSource

File path or stream to read from

components ComponentList

Set of components to read

config ChartReadingConfiguration

Optional read configuration

Returns

Song

ReadComponentsAsync(ReadingDataSource, ComponentList, ChartReadingConfiguration?, CancellationToken)

Reads a a set of Song components from a chart target asynchronously.

public static Task<Song> ReadComponentsAsync(ReadingDataSource source, ComponentList components, ChartReadingConfiguration? config = null, CancellationToken cancellationToken = default)

Parameters

source ReadingDataSource

File path or stream to read from

components ComponentList

Set of components to read

config ChartReadingConfiguration

Optional read configuration

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<Song>

Remarks

Uses multi-threading to parse song components.

ReadGlobalEvents(ReadingDataSource)

Reads the set of GlobalEvent from a chart target.

public static List<GlobalEvent> ReadGlobalEvents(ReadingDataSource source)

Parameters

source ReadingDataSource

File path or stream to read from

Returns

List<GlobalEvent>

ReadGlobalEventsAsync(ReadingDataSource, CancellationToken)

Reads the set of GlobalEvent from a chart target asynchronously.

public static Task<List<GlobalEvent>> ReadGlobalEventsAsync(ReadingDataSource source, CancellationToken cancellationToken = default)

Parameters

source ReadingDataSource

File path or stream to read from

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<List<GlobalEvent>>

ReadInstruments(ReadingDataSource, InstrumentComponentList, ChartReadingConfiguration?)

Reads a set of Instrument from a chart target.

public static InstrumentSet ReadInstruments(ReadingDataSource source, InstrumentComponentList components, ChartReadingConfiguration? config = null)

Parameters

source ReadingDataSource

File path or stream to read from

components InstrumentComponentList

Instruments to read

config ChartReadingConfiguration

Optional read config

Returns

InstrumentSet

ReadInstrumentsAsync(ReadingDataSource, InstrumentComponentList, ChartReadingConfiguration?, CancellationToken)

Reads a set of Instrument from a chart target asynchronously.

public static Task<InstrumentSet> ReadInstrumentsAsync(ReadingDataSource source, InstrumentComponentList components, ChartReadingConfiguration? config = null, CancellationToken cancellationToken = default)

Parameters

source ReadingDataSource

File path or stream to read from

components InstrumentComponentList

Instruments to read

config ChartReadingConfiguration

Optional read config

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<InstrumentSet>

Remarks

Uses multi-threading to parse tracks.

ReadMetadata(ReadingDataSource, Metadata?)

Reads the Metadata from a chart target.

public static Metadata ReadMetadata(ReadingDataSource source, Metadata? existing = null)

Parameters

source ReadingDataSource

File path or stream to read from

existing Metadata

Metadata from another target to combine with

Returns

Metadata

Metadata object provided as the existing parameter, or a new instance if passed null.

ReadMetadataAsync(ReadingDataSource, Metadata?, CancellationToken)

Reads the Metadata from a chart target asynchronously.

public static Task<Metadata> ReadMetadataAsync(ReadingDataSource source, Metadata? existing = null, CancellationToken cancellationToken = default)

Parameters

source ReadingDataSource

File path or stream to read from

existing Metadata

Metadata from another target to combine with

cancellationToken CancellationToken

Token to request cancellation

Returns

Task<Metadata>

Metadata object provided as the existing parameter, or a new instance if passed null.

ReadSong(ReadingDataSource, ChartReadingConfiguration?)

Reads a Song from a chart target.

public static Song ReadSong(ReadingDataSource source, ChartReadingConfiguration? config = null)

Parameters

source ReadingDataSource

File path or stream to read from

config ChartReadingConfiguration

Optional read configuration

Returns

Song

ReadSongAsync(ReadingDataSource, ChartReadingConfiguration?, CancellationToken)

Reads a Song from a chart target asynchronously.

public static Task<Song> ReadSongAsync(ReadingDataSource source, ChartReadingConfiguration? config = null, CancellationToken cancellationToken = default)

Parameters

source ReadingDataSource

File path or stream to read from

config ChartReadingConfiguration

Optional read configuration

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<Song>

Remarks

Uses multi-threading to parse song components.

ReadSyncTrack(ReadingDataSource, ChartReadingConfiguration?)

Reads the SyncTrack from a chart target.

public static SyncTrack ReadSyncTrack(ReadingDataSource source, ChartReadingConfiguration? config = null)

Parameters

source ReadingDataSource

File path or stream to read from

config ChartReadingConfiguration

Optional read config

Returns

SyncTrack

ReadSyncTrackAsync(ReadingDataSource, ChartReadingConfiguration?, CancellationToken)

Reads the SyncTrack from a chart target asynchronously.

public static Task<SyncTrack> ReadSyncTrackAsync(ReadingDataSource source, ChartReadingConfiguration? config = null, CancellationToken cancellationToken = default)

Parameters

source ReadingDataSource

File path or stream to read from

config ChartReadingConfiguration

Optional read config

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<SyncTrack>

ReadVocals(ReadingDataSource)

Reads the StandardVocalsTrack from a chart target.

public static StandardVocalsTrack ReadVocals(ReadingDataSource source)

Parameters

source ReadingDataSource

File path or stream to read from

Returns

StandardVocalsTrack

ReadVocalsAsync(ReadingDataSource, CancellationToken)

Reads the StandardVocalsTrack from a chart target asynchronously.

public static Task<StandardVocalsTrack> ReadVocalsAsync(ReadingDataSource source, CancellationToken cancellationToken = default)

Parameters

source ReadingDataSource

File path or stream to read from

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<StandardVocalsTrack>

ReplaceComponents(WritingDataSource, Song, ComponentList, ChartWritingConfiguration?)

Replaces a set of Song components in a chart target.

public static void ReplaceComponents(WritingDataSource source, Song song, ComponentList components, ChartWritingConfiguration? config = null)

Parameters

source WritingDataSource

File path or stream to write to

song Song

Song data to write

components ComponentList

Set of components to replace

config ChartWritingConfiguration

Optional write config

ReplaceComponentsAsync(WritingDataSource, Song, ComponentList, ChartWritingConfiguration?, CancellationToken)

Replaces a set of Song components in a chart target asynchronously.

public static Task ReplaceComponentsAsync(WritingDataSource source, Song song, ComponentList components, ChartWritingConfiguration? config = null, CancellationToken cancellationToken = default)

Parameters

source WritingDataSource

File path or stream to write to

song Song

Song data to write

components ComponentList

Set of components to replace

config ChartWritingConfiguration

Optional write config

cancellationToken CancellationToken

Token used for cancellation

Returns

Task

Remarks

Uses multi-threading to serialize song components.

ReplaceGlobalEvents(WritingDataSource, IEnumerable<GlobalEvent>)

Replaces the set of GlobalEvent in a chart target.

public static void ReplaceGlobalEvents(WritingDataSource source, IEnumerable<GlobalEvent> events)

Parameters

source WritingDataSource

File path or stream to write to

events IEnumerable<GlobalEvent>

Events to use as a replacement

ReplaceGlobalEventsAsync(WritingDataSource, IEnumerable<GlobalEvent>, CancellationToken)

Replaces the set of GlobalEvent in a chart target asynchronously.

public static Task ReplaceGlobalEventsAsync(WritingDataSource source, IEnumerable<GlobalEvent> events, CancellationToken cancellationToken = default)

Parameters

source WritingDataSource

File path or stream to write to

events IEnumerable<GlobalEvent>

Events to use as a replacement

cancellationToken CancellationToken

Token used for cancellation

Returns

Task

ReplaceInstruments(WritingDataSource, InstrumentSet, InstrumentComponentList, ChartWritingConfiguration?, FormattingRules?)

Replaces a set of instruments in a chart target.

public static void ReplaceInstruments(WritingDataSource source, InstrumentSet set, InstrumentComponentList components, ChartWritingConfiguration? config = null, FormattingRules? formatting = null)

Parameters

source WritingDataSource

File path or stream to write to

set InstrumentSet

Instrument data to write

components InstrumentComponentList

Set of instruments and tracks to replace

config ChartWritingConfiguration

Optional write config

formatting FormattingRules

Formatting to apply

ReplaceInstrumentsAsync(WritingDataSource, InstrumentSet, InstrumentComponentList, ChartWritingConfiguration?, FormattingRules?, CancellationToken)

Replaces a set of instruments in a chart target asynchronously.

public static Task ReplaceInstrumentsAsync(WritingDataSource source, InstrumentSet set, InstrumentComponentList components, ChartWritingConfiguration? config = null, FormattingRules? formatting = null, CancellationToken cancellationToken = default)

Parameters

source WritingDataSource

File path or stream to write to

set InstrumentSet

Instrument data to write

components InstrumentComponentList

Set of instruments and tracks to replace

config ChartWritingConfiguration

Optional write config

formatting FormattingRules

Formatting to apply

cancellationToken CancellationToken

Token used for cancellation

Returns

Task

ReplaceMetadata(WritingDataSource, Metadata)

Replaces the Metadata in a chart target.

public static void ReplaceMetadata(WritingDataSource source, Metadata metadata)

Parameters

source WritingDataSource

File path or stream to write to

metadata Metadata

Metadata to write

ReplaceMetadataAsync(WritingDataSource, Metadata, CancellationToken)

Replaces the Metadata in a chart target asynchronously.

public static Task ReplaceMetadataAsync(WritingDataSource source, Metadata metadata, CancellationToken cancellationToken = default)

Parameters

source WritingDataSource

File path or stream to write to

metadata Metadata

Metadata to write

cancellationToken CancellationToken

Token used for cancellation

Returns

Task

ReplaceSyncTrack(WritingDataSource, SyncTrack, ChartWritingConfiguration?)

Replaces the sync track in a chart target.

public static void ReplaceSyncTrack(WritingDataSource source, SyncTrack syncTrack, ChartWritingConfiguration? config = null)

Parameters

source WritingDataSource

File path or stream to write to

syncTrack SyncTrack

Sync track to write

config ChartWritingConfiguration

Optional write configuration

ReplaceSyncTrackAsync(WritingDataSource, SyncTrack, ChartWritingConfiguration?, CancellationToken)

Replaces the sync track in a chart target asynchronously.

public static Task ReplaceSyncTrackAsync(WritingDataSource source, SyncTrack syncTrack, ChartWritingConfiguration? config = null, CancellationToken cancellationToken = default)

Parameters

source WritingDataSource

File path or stream to write to

syncTrack SyncTrack

Sync track to write

config ChartWritingConfiguration

Optional write configuration

cancellationToken CancellationToken

Token used for cancellation

Returns

Task

WriteSong(WritingDataSource, Song, ChartWritingConfiguration?)

Writes a Song to a chart target.

public static void WriteSong(WritingDataSource source, Song song, ChartWritingConfiguration? config = null)

Parameters

source WritingDataSource

File path or stream to write to

song Song

Song to write

config ChartWritingConfiguration

Optional write configuration

WriteSongAsync(WritingDataSource, Song, ChartWritingConfiguration?, CancellationToken)

Writes a Song to a chart target asynchronously.

public static Task WriteSongAsync(WritingDataSource source, Song song, ChartWritingConfiguration? config = null, CancellationToken cancellationToken = default)

Parameters

source WritingDataSource

File path or stream to write to

song Song

Song to write

config ChartWritingConfiguration

Optional write configuration

cancellationToken CancellationToken

Token to request cancellation

Returns

Task

Remarks

Uses multi-threading to serialize song components.