Class SanitizingSettings

Settings which control how a MIDI file should be sanitized with the Sanitizer tool. More info in the Sanitizer: Settings article.

Inheritance

object

SanitizingSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Melanchall.DryWetMidi.Tools

Assembly: Melanchall.DryWetMidi.dll

Syntax

public sealed class SanitizingSettings

Properties

NoteDetectionSettings

Gets or sets settings which define how notes should be detected and built. More info in the Getting objects: GetNotes: Settings article.

Declaration

public NoteDetectionSettings NoteDetectionSettings { get; set; }

Property Value

Type	Description
NoteDetectionSettings

NoteMaxLengthForOrphanedNoteOnEvent

Gets or sets a maximum length for a new note restored by an orphaned Note On event. This property is used only when OrphanedNoteOnEventsPolicy is set to CompleteNote. The default value is 1/4 (Quarter). More info in the Sanitizer: OrphanedNoteOnEventsPolicy article.

Declaration

public ITimeSpan NoteMaxLengthForOrphanedNoteOnEvent { get; set; }

Property Value

Type	Description
ITimeSpan

NoteMinLength

Gets or sets a minimum length for notes within an input file. All notes that are shorter than this value will be removed. The default value is null which means notes can have any length. NoteDetectionSettings property affects how notes are detected. More info in the Sanitizer: NoteMinLength article.

Declaration

public ITimeSpan NoteMinLength { get; set; }

Property Value

Type	Description
ITimeSpan

NoteMinVelocity

Gets or sets a minimum velocity for notes within an input file. All notes with velocity below this value will be removed. The default value is zero which means notes can have any velocity. NoteDetectionSettings property affects how notes are detected. More info in the Sanitizer: NoteMinVelocity article.

Declaration

public SevenBitNumber NoteMinVelocity { get; set; }

Property Value

Type	Description
SevenBitNumber

OrphanedNoteOnEventsPolicy

Gets or sets a value indicating how Note On (see NoteOnEvent) events without corresponding Note Off ones should be handled. The default value is Remove. NoteDetectionSettings property affects how notes (and thus orphaned Note On events) are detected. More info in the Sanitizer: OrphanedNoteOnEventsPolicy article.

Declaration

public OrphanedNoteOnEventsPolicy OrphanedNoteOnEventsPolicy { get; set; }

Property Value

Type	Description
OrphanedNoteOnEventsPolicy

RemoveDuplicatedControlChangeEvents

Gets or sets a value indicating whether duplicated Control Change (see ControlChangeEvent) events should be removed or not. The default value is true. More info in the Sanitizer: RemoveDuplicatedControlChangeEvents article.

Declaration

public bool RemoveDuplicatedControlChangeEvents { get; set; }

Property Value

Type	Description
bool

RemoveDuplicatedNotes

Gets or sets a value indicating whether duplicated notes should be removed or not. The default value is true. More info in the Sanitizer: RemoveDuplicatedNotes article.

Declaration

public bool RemoveDuplicatedNotes { get; set; }

Property Value

Type	Description
bool

RemoveDuplicatedPitchBendEvents

Gets or sets a value indicating whether duplicated Pitch Bend (see PitchBendEvent) events should be removed or not. The default value is true. More info in the Sanitizer: RemoveDuplicatedPitchBendEvents article.

Declaration

public bool RemoveDuplicatedPitchBendEvents { get; set; }

Property Value

Type	Description
bool

RemoveDuplicatedSequenceTrackNameEvents

Gets or sets a value indicating whether duplicated Sequence/Track Name (see SequenceTrackNameEvent) events should be removed or not. The default value is true. More info in the Sanitizer: RemoveDuplicatedSequenceTrackNameEvents article.

Declaration

public bool RemoveDuplicatedSequenceTrackNameEvents { get; set; }

Property Value

Type	Description
bool

RemoveDuplicatedSetTempoEvents

Gets or sets a value indicating whether duplicated Set Tempo (see SetTempoEvent) events should be removed or not. The default value is true. More info in the Sanitizer: RemoveDuplicatedSetTempoEvents article.

Declaration

public bool RemoveDuplicatedSetTempoEvents { get; set; }

Property Value

Type	Description
bool

RemoveDuplicatedTimeSignatureEvents

Gets or sets a value indicating whether duplicated Time Signature (see TimeSignatureEvent) events should be removed or not. The default value is true. More info in the Sanitizer: RemoveDuplicatedTimeSignatureEvents article.

Declaration

public bool RemoveDuplicatedTimeSignatureEvents { get; set; }

Property Value

Type	Description
bool

RemoveEmptyTrackChunks

Gets or sets a value indicating whether empty track chunks should be removed or not. The default value is true. More info in the Sanitizer: RemoveEmptyTrackChunks article.

Declaration

public bool RemoveEmptyTrackChunks { get; set; }

Property Value

Type	Description
bool

RemoveEventsOnUnusedChannels

Gets or sets a value indicating whether events on unused channels should be removed or not. Unused channel means there are no notes on this channel. The default value is true. More info in the Sanitizer: RemoveEventsOnUnusedChannels article.

Declaration

public bool RemoveEventsOnUnusedChannels { get; set; }

Property Value

Type	Description
bool

RemoveOrphanedNoteOffEvents

Gets or sets a value indicating whether Note Off (see NoteOffEvent) events without corresponding Note On ones should be removed or not. The default value is true. NoteDetectionSettings property affects how notes (and thus orphaned Note Off events) are detected. More info in the Sanitizer: RemoveOrphanedNoteOffEvents article.

Declaration

public bool RemoveOrphanedNoteOffEvents { get; set; }

Property Value

Type	Description
bool

Trim

Gets or sets a value indicating whether a silence at the start of a MIDI file should be removed or not. The default value is false. More info in the Sanitizer: Trim article.

Declaration

public bool Trim { get; set; }

Property Value

Type	Description
bool