Class WritingSettings

Settings according to which MIDI data should be written.

Inheritance

object

WritingSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Melanchall.DryWetMidi.Core

Assembly: Melanchall.DryWetMidi.dll

Syntax

public class WritingSettings

Properties

CustomMetaEventTypes

Gets or sets collection of custom meta events types.

Declaration

public EventTypesCollection CustomMetaEventTypes { get; set; }

Property Value

Type	Description
EventTypesCollection

Remarks

Types within this collection must be derived from the MetaEvent class and have parameterless constructor. No exception will be thrown while writing a MIDI file if some types don't meet these requirements.

DeleteDefaultKeySignature

Gets or sets a value indicating whether Key Signature events with default data should be deleted if there are no non-default ones before them, or not. The default value is false.

Declaration

public bool DeleteDefaultKeySignature { get; set; }

Property Value

Type	Description
bool

DeleteDefaultSetTempo

Gets or sets a value indicating whether Set Tempo events with default data should be deleted if there are no non-default ones before them, or not. The default value is false.

Declaration

public bool DeleteDefaultSetTempo { get; set; }

Property Value

Type	Description
bool

DeleteDefaultTimeSignature

Gets or sets a value indicating whether Time Signature events with default data should be deleted if there are no non-default ones before them, or not. The default value is false.

Declaration

public bool DeleteDefaultTimeSignature { get; set; }

Property Value

Type	Description
bool

DeleteUnknownChunks

Gets or sets a value indicating whether chunks of UnknownChunk type should be deleted or not. The default value is false.

Declaration

public bool DeleteUnknownChunks { get; set; }

Property Value

Type	Description
bool

DeleteUnknownMetaEvents

Gets or sets a value indicating whether events of UnknownMetaEvent type should be deleted or not. The default value is false.

Declaration

public bool DeleteUnknownMetaEvents { get; set; }

Property Value

Type	Description
bool

NoteOffAsSilentNoteOn

Gets or sets a value indicating whether Note Off events should be written as Note On ones with velocity of zero, or not. In conjunction with UseRunningStatus set to true can give some compression of MIDI data. The default value is false.

Declaration

public bool NoteOffAsSilentNoteOn { get; set; }

Property Value

Type	Description
bool

TextEncoding

Gets or sets an Encoding that will be used to write the text of a text-based meta event. The default is ASCII.

Declaration

public Encoding TextEncoding { get; set; }

Property Value

Type	Description
Encoding

UseRunningStatus

Gets or sets a value indicating whether 'running status' (to turn off writing of the status bytes of consecutive events of the same type) should be used or not. The default value is false.

Declaration

public bool UseRunningStatus { get; set; }

Property Value

Type	Description
bool

WriteHeaderChunk

Gets or sets a value indicating whether header chunk should be written to a MIDI file or not. The default value is true.

Declaration

public bool WriteHeaderChunk { get; set; }

Property Value

Type	Description
bool

Remarks

Note that missed header chunk violates SMF specification and thus applications may not read such files.

WriterSettings

Gets or sets settings according to which MidiWriter should write MIDI data.

Declaration

public WriterSettings WriterSettings { get; set; }

Property Value

Type	Description
WriterSettings

Remarks

These settings specify reading binary data without knowledge about MIDI data structures.