Class SyncTrack

Namespace

ChartTools

Assembly

ChartTools.dll

Set of markers that define the time signature and tempo

public class SyncTrack : IEmptyVerifiable

Inheritance

object

SyncTrack

Implements

IEmptyVerifiable

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(SyncTrack, float)

Properties

IsEmpty

true if containing no data

public bool IsEmpty { get; }

Property Value

bool

Tempo

Tempo markers

public TempoMap Tempo { get; }

Property Value

TempoMap

TimeSignatures

Time signature markers

public List<TimeSignature> TimeSignatures { get; }

Property Value

List<TimeSignature>

Methods

FromFile(string, ReadingConfiguration?, FormattingRules?)

Reads a SyncTrack from a file.

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

Parameters

path string

Path of the file to read from

config ReadingConfiguration

Optional read config

formatting FormattingRules

Expected formatting

Returns

SyncTrack

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

Reads a SyncTrack from a file asynchronously.

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

Parameters

path string

Path of the file to read from

config ReadingConfiguration

Optional read config

formatting FormattingRules

Expected formatting

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<SyncTrack>

ToFile(string, WritingConfiguration?, FormattingRules?)

Replaces the SyncTrack in a file.

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

Parameters

path string

Path of the file to write to

config WritingConfiguration

Optional write config

formatting FormattingRules

Formatting to apply

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

Replaces the SyncTrack in a file asynchronously.

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

Parameters

path string

Path of the file to write to

config WritingConfiguration

Optional write config

formatting FormattingRules

Formatting to apply

cancellationToken CancellationToken

Token used for cancellation

Returns

Task