Class TimedObjectUtilities

Extension methods for objects that implement the ITimedObject interface.

Inheritance

Object

TimedObjectUtilities

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Melanchall.DryWetMidi.Interaction

Assembly: Melanchall.DryWetMidi.dll

Syntax

public static class TimedObjectUtilities

Methods

AddObjects(EventsCollection, IEnumerable<ITimedObject>)

Adds the specified collection of objects to EventsCollection.

Declaration

public static void AddObjects(this EventsCollection eventsCollection, IEnumerable<ITimedObject> timedObjects)

Parameters

Type	Name	Description
EventsCollection	eventsCollection	EventsCollection to add objects to.
IEnumerable<ITimedObject>	timedObjects	Objects to add to eventsCollection.

Exceptions

Type	Condition
ArgumentNullException	One of the following errors occurred: eventsCollection is null. timedObjects is null.

AddObjects(TrackChunk, IEnumerable<ITimedObject>)

Adds the specified collection of objects to TrackChunk.

Declaration

public static void AddObjects(this TrackChunk trackChunk, IEnumerable<ITimedObject> timedObjects)

Parameters

Type	Name	Description
TrackChunk	trackChunk	TrackChunk to add objects to.
IEnumerable<ITimedObject>	timedObjects	Objects to add to trackChunk.

Exceptions

Type	Condition
ArgumentNullException	One of the following errors occurred: trackChunk is null. timedObjects is null.

AtTime<TObject>(IEnumerable<TObject>, ITimeSpan, TempoMap)

Filters collection of ITimedObject to return objects at the specified time.

Declaration

public static IEnumerable<TObject> AtTime<TObject>(this IEnumerable<TObject> objects, ITimeSpan time, TempoMap tempoMap)
    where TObject : ITimedObject

Parameters

Type	Name	Description
IEnumerable<TObject>	objects	A collection to filter.
ITimeSpan	time	Time to filter objects by.
TempoMap	tempoMap	Tempo map to filter objects by time.

Returns

Type	Description
IEnumerable<TObject>	A collection that contains objects from the input sequence that are at the specified time.

Type Parameters

Name	Description
TObject	The type of the elements of objects.

Remarks

Note that changes made on the objects returned by this method will not be saved to an underlying data source (events collection, track chunk, file). To change properties of timed objects and save them you need to use a manager appropriate for an object's type.

Exceptions

Type	Condition
ArgumentNullException	One of the following errors occurred: objects is null. time is null. tempoMap is null.

AtTime<TObject>(IEnumerable<TObject>, Int64)

Filters collection of ITimedObject to return objects at the specified time.

Declaration

public static IEnumerable<TObject> AtTime<TObject>(this IEnumerable<TObject> objects, long time)
    where TObject : ITimedObject

Parameters

Type	Name	Description
IEnumerable<TObject>	objects	A collection to filter.
Int64	time	Time to filter objects by.

Returns

Type	Description
IEnumerable<TObject>	A collection that contains objects from the input sequence that are at the specified time.

Type Parameters

Name	Description
TObject	The type of the elements of objects.

Remarks

Note that changes made on the objects returned by this method will not be saved to an underlying data source (events collection, track chunk, file). To change properties of timed objects and save them you need to use a manager appropriate for an object's type.

Exceptions

Type	Condition
ArgumentNullException	objects is null.
ArgumentOutOfRangeException	time is negative.

SetTime<TObject>(TObject, ITimeSpan, TempoMap)

Sets time of the specified object in terms of ITimeSpan.

Declaration

public static TObject SetTime<TObject>(this TObject obj, ITimeSpan time, TempoMap tempoMap)
    where TObject : ITimedObject

Parameters

Type	Name	Description
TObject	obj	Object to set time of.
ITimeSpan	time	New time of the obj.
TempoMap	tempoMap	TempoMap used to calculate new time in ticks.

Returns

Type	Description
TObject	The same object the method was called on.

Type Parameters

Name	Description
TObject	The type of the obj.

Exceptions

Type	Condition
ArgumentNullException	One of the following errors occurred: obj is null. time is null. tempoMap is null. One of the objects is null.

TimeAs(ITimedObject, TimeSpanType, TempoMap)

Gets time of an ITimedObject as an instance of time span defined by the specified time span type.

Declaration

public static ITimeSpan TimeAs(this ITimedObject obj, TimeSpanType timeType, TempoMap tempoMap)

Parameters

Type	Name	Description
ITimedObject	obj	Object to get time of.
TimeSpanType	timeType	The type of time span to convert the time of obj to.
TempoMap	tempoMap	Tempo map to calculate time of the obj.

Returns

Type	Description
ITimeSpan	Time of the specified object as an instance of time span defined by the timeType.

Exceptions

Type	Condition
ArgumentNullException	One of the following errors occurred: obj is null. tempoMap is null.
InvalidEnumArgumentException	timeType specified an invalid value.

TimeAs<TTime>(ITimedObject, TempoMap)

Gets time of an ITimedObject as an instance of type that implements the ITimeSpan interface.

Declaration

public static TTime TimeAs<TTime>(this ITimedObject obj, TempoMap tempoMap)
    where TTime : ITimeSpan

Parameters

Type	Name	Description
ITimedObject	obj	Object to get time of.
TempoMap	tempoMap	Tempo map to calculate time of the obj.

Returns

Type	Description
TTime	Time of the specified object as an instance of TTime.

Type Parameters

Name	Description
TTime	Type that will represent the time of the obj.

Exceptions

Type	Condition
ArgumentNullException	One of the following errors occurred: obj is null. tempoMap is null.
NotSupportedException	TTime is not supported.

ToFile(IEnumerable<ITimedObject>)

Creates a MIDI file with the specified timed objects.

Declaration

public static MidiFile ToFile(this IEnumerable<ITimedObject> timedObjects)

Parameters

Type	Name	Description
IEnumerable<ITimedObject>	timedObjects	Collection of objects to create a MIDI file from.

Returns

Type	Description
MidiFile	MidiFile containing the timedObjects.

Remarks

Note that only MIDI events allowed by SMF specification will be added to result MIDI file. So instances of TimedEvent containing SystemCommonEvent or SystemRealTimeEvent won't be added.

Exceptions

Type	Condition
ArgumentNullException	timedObjects is null.

ToTrackChunk(IEnumerable<ITimedObject>)

Creates a track chunk with the specified objects.

Declaration

public static TrackChunk ToTrackChunk(this IEnumerable<ITimedObject> timedObjects)

Parameters

Type	Name	Description
IEnumerable<ITimedObject>	timedObjects	Collection of objects to create a track chunk from.

Returns

Type	Description
TrackChunk	TrackChunk containing the timedObjects.

Remarks

Note that only MIDI events allowed by SMF specification will be added to result track chunk. So instances of TimedEvent containing SystemCommonEvent or SystemRealTimeEvent won't be added.

Exceptions

Type	Condition
ArgumentNullException	timedObjects is null.