Class RestsUtilities

Provides methods to get rests between different objects.

Inheritance

object

RestsUtilities

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 RestsUtilities

Methods

GetRests(IEnumerable<ITimedObject>, RestDetectionSettings)

Returns rests between objects within the specified collection according to the provided settings. Rests in the result collection are ordered by time.

Declaration

public static ICollection<Rest> GetRests(this IEnumerable<ITimedObject> timedObjects, RestDetectionSettings settings = null)

Parameters

Type	Name	Description
IEnumerable<ITimedObject>	timedObjects	The input objects collection.
RestDetectionSettings	settings	Settings according to which rests should be detected and built.

Returns

Type	Description
ICollection<Rest>	Collection of rests between objects within timedObjects.

Exceptions

Type	Condition
ArgumentNullException	timedObjects is null.

WithRests(IEnumerable<ITimedObject>, RestDetectionSettings)

Returns a collection of the specified objects and rests between them according to the provided settings. Objects (including rests) in the result collection are ordered by time.

Declaration

public static IEnumerable<ITimedObject> WithRests(this IEnumerable<ITimedObject> timedObjects, RestDetectionSettings settings = null)

Parameters

Type	Name	Description
IEnumerable<ITimedObject>	timedObjects	The input objects collection.
RestDetectionSettings	settings	Settings according to which rests should be detected and built.

Returns

Type	Description
IEnumerable<ITimedObject>	Collection with objects from timedObjects and rests between them.

Exceptions

Type	Condition
ArgumentNullException	timedObjects is null.