Class GetObjectsUtilities

Provides utilities to extract objects of different types at once. More info in the Getting objects: GetObjects article.
Inheritance
object
GetObjectsUtilities
Inherited Members
Namespace: Melanchall.DryWetMidi.Interaction
Assembly: Melanchall.DryWetMidi.dll
Syntax
public static class GetObjectsUtilities

Methods

EnumerateObjects(IEnumerable<MidiEvent>, ObjectType, ObjectDetectionSettings)

Extracts objects of the specified types from a collection of MidiEvent returning them as a lazy collection.
Declaration
public static IEnumerable<ITimedObject> EnumerateObjects(this IEnumerable<MidiEvent> midiEvents, ObjectType objectType, ObjectDetectionSettings settings = null)
Parameters
Type Name Description
IEnumerable<MidiEvent> midiEvents Collection of MidiEvent to extract objects from.
ObjectType objectType Combination of desired objects types.
ObjectDetectionSettings settings Settings according to which objects should be detected and built.
Returns
Type Description
IEnumerable<ITimedObject> A lazy collection of objects built on top of midiEvents.
Exceptions
Type Condition
ArgumentNullException midiEvents is null.

GetObjects(EventsCollection, ObjectType, ObjectDetectionSettings)

Extracts objects of the specified types from a EventsCollection.
Declaration
public static ICollection<ITimedObject> GetObjects(this EventsCollection eventsCollection, ObjectType objectType, ObjectDetectionSettings settings = null)
Parameters
Type Name Description
EventsCollection eventsCollection EventsCollection to extract objects from.
ObjectType objectType Combination of desired objects types.
ObjectDetectionSettings settings Settings according to which objects should be detected and built.
Returns
Type Description
ICollection<ITimedObject> Collection of objects of the specified types extracted from eventsCollection. Objects are ordered by time.
Exceptions
Type Condition
ArgumentNullException eventsCollection is null.

GetObjects(MidiFile, ObjectType, ObjectDetectionSettings)

Extracts objects of the specified types from a MidiFile.
Declaration
public static ICollection<ITimedObject> GetObjects(this MidiFile midiFile, ObjectType objectType, ObjectDetectionSettings settings = null)
Parameters
Type Name Description
MidiFile midiFile MidiFile to extract objects from.
ObjectType objectType Combination of desired objects types.
ObjectDetectionSettings settings Settings according to which objects should be detected and built.
Returns
Type Description
ICollection<ITimedObject> Collection of objects of the specified types extracted from midiFile. Objects are ordered by time.
Exceptions
Type Condition
ArgumentNullException midiFile is null.

GetObjects(TrackChunk, ObjectType, ObjectDetectionSettings)

Extracts objects of the specified types from a TrackChunk.
Declaration
public static ICollection<ITimedObject> GetObjects(this TrackChunk trackChunk, ObjectType objectType, ObjectDetectionSettings settings = null)
Parameters
Type Name Description
TrackChunk trackChunk TrackChunk to extract objects from.
ObjectType objectType Combination of desired objects types.
ObjectDetectionSettings settings Settings according to which objects should be detected and built.
Returns
Type Description
ICollection<ITimedObject> Collection of objects of the specified types extracted from trackChunk. Objects are ordered by time.
Exceptions
Type Condition
ArgumentNullException trackChunk is null.

GetObjects(IEnumerable<MidiEvent>, ObjectType, ObjectDetectionSettings)

Extracts objects of the specified types from a collection of MidiEvent.
Declaration
public static ICollection<ITimedObject> GetObjects(this IEnumerable<MidiEvent> midiEvents, ObjectType objectType, ObjectDetectionSettings settings = null)
Parameters
Type Name Description
IEnumerable<MidiEvent> midiEvents Collection of MidiEvent to extract objects from.
ObjectType objectType Combination of desired objects types.
ObjectDetectionSettings settings Settings according to which objects should be detected and built.
Returns
Type Description
ICollection<ITimedObject> Collection of objects of the specified types extracted from midiEvents. Objects are ordered by time.
Exceptions
Type Condition
ArgumentNullException midiEvents is null.

GetObjects(IEnumerable<TrackChunk>, ObjectType, ObjectDetectionSettings)

Extracts objects of the specified types from a collection of TrackChunk.
Declaration
public static ICollection<ITimedObject> GetObjects(this IEnumerable<TrackChunk> trackChunks, ObjectType objectType, ObjectDetectionSettings settings = null)
Parameters
Type Name Description
IEnumerable<TrackChunk> trackChunks Collection of TrackChunk to extract objects from.
ObjectType objectType Combination of desired objects types.
ObjectDetectionSettings settings Settings according to which objects should be detected and built.
Returns
Type Description
ICollection<ITimedObject> Collection of objects of the specified types extracted from trackChunks. Objects are ordered by time.
Exceptions
Type Condition
ArgumentNullException trackChunks is null.

GetObjects(IEnumerable<ITimedObject>, ObjectType, ObjectDetectionSettings)

Extracts objects of the specified types from a collection of ITimedObject.
Declaration
public static ICollection<ITimedObject> GetObjects(this IEnumerable<ITimedObject> timedObjects, ObjectType objectType, ObjectDetectionSettings settings = null)
Parameters
Type Name Description
IEnumerable<ITimedObject> timedObjects Collection of ITimedObject to extract objects from.
ObjectType objectType Combination of desired objects types.
ObjectDetectionSettings settings Settings according to which objects should be detected and built.
Returns
Type Description
ICollection<ITimedObject> Collection of objects of the specified types extracted from timedObjects. Objects are ordered by time.
Exceptions
Type Condition
ArgumentNullException timedObjects is null.