Class MidiWriter

Writer of the MIDI data types.
Inheritance
Object
MidiWriter
Implements
Inherited Members
Namespace: Melanchall.DryWetMidi.Core
Assembly: Melanchall.DryWetMidi.dll
Syntax
public sealed class MidiWriter : IDisposable

Constructors

MidiWriter(Stream, WriterSettings)

Initializes a new instance of the MidiWriter with the specified stream.
Declaration
public MidiWriter(Stream stream, WriterSettings settings)
Parameters
Type Name Description
Stream stream Stream to write MIDI file to.
WriterSettings settings Settings according to which MIDI data should be written.
Exceptions
Type Condition
ArgumentNullException

One of the following errors occurred:

  • stream is null.
  • settings is null.
ArgumentException stream does not support writing, or is already closed.

Properties

Length

Gets the current count of written bytes.
Declaration
public long Length { get; }
Property Value
Type Description
Int64

Methods

Dispose()

Releases all resources used by the current instance of the MidiWriter class.
Declaration
public void Dispose()

Write3ByteDword(UInt32)

Writes a DWORD value (32-bit unsigned integer) to the underlying stream as three bytes and advances the current position by three bytes.
Declaration
public void Write3ByteDword(uint value)
Parameters
Type Name Description
UInt32 value DWORD value to write.
Exceptions
Type Condition
ObjectDisposedException Method was called after the writer was disposed.
IOException An I/O error occurred on the underlying stream.

WriteByte(Byte)

Writes an unsigned byte to the underlying stream and advances the stream position by one byte.
Declaration
public void WriteByte(byte value)
Parameters
Type Name Description
Byte value The unsigned byte to write.
Exceptions
Type Condition
ObjectDisposedException Method was called after the writer was disposed.
IOException An I/O error occurred on the underlying stream.

WriteBytes(Byte[])

Writes a byte array to the underlying stream.
Declaration
public void WriteBytes(byte[] bytes)
Parameters
Type Name Description
Byte[] bytes A byte array containing the data to write.
Exceptions
Type Condition
ArgumentNullException bytes is null.
ObjectDisposedException Method was called after the writer was disposed.
IOException An I/O error occurred on the underlying stream.

WriteDword(UInt32)

Writes a DWORD value (32-bit unsigned integer) to the underlying stream and advances the current position by four bytes.
Declaration
public void WriteDword(uint value)
Parameters
Type Name Description
UInt32 value DWORD value to write.
Exceptions
Type Condition
ObjectDisposedException Method was called after the writer was disposed.
IOException An I/O error occurred on the underlying stream.

WriteInt16(Int16)

Writes a INT16 value (16-bit signed integer) to the underlying stream and advances the current position by two bytes.
Declaration
public void WriteInt16(short value)
Parameters
Type Name Description
Int16 value INT16 value to write.
Exceptions
Type Condition
ObjectDisposedException Method was called after the writer was disposed.
IOException An I/O error occurred on the underlying stream.

WriteSByte(SByte)

Writes a signed byte to the underlying stream and advances the stream position by one byte.
Declaration
public void WriteSByte(sbyte value)
Parameters
Type Name Description
SByte value The signed byte to write.
Exceptions
Type Condition
ObjectDisposedException Method was called after the writer was disposed.
IOException An I/O error occurred on the underlying stream.

WriteString(String)

Writes a string to the underlying stream as set of ASCII bytes.
Declaration
public void WriteString(string value)
Parameters
Type Name Description
String value The string to write.
Exceptions
Type Condition
ObjectDisposedException Method was called after the writer was disposed.
IOException An I/O error occurred on the underlying stream.

WriteVlqNumber(Int32)

Writes a 32-bit signed integer to the underlying stream in compressed format called variable-length quantity (VLQ).
Declaration
public void WriteVlqNumber(int value)
Parameters
Type Name Description
Int32 value The value to write.
Remarks
Numbers in VLQ format are represented 7 bits per byte, most significant bits first. All bytes except the last have bit 7 set, and the last byte has bit 7 clear. If the number is between 0 and 127, it is thus represented exactly as one byte.
Exceptions
Type Condition
ObjectDisposedException Method was called after the writer was disposed.
IOException An I/O error occurred on the underlying stream.

WriteVlqNumber(Int64)

Writes a 64-bit signed integer to the underlying stream in compressed format called variable-length quantity (VLQ).
Declaration
public void WriteVlqNumber(long value)
Parameters
Type Name Description
Int64 value The value to write.
Remarks
Numbers in VLQ format are represented 7 bits per byte, most significant bits first. All bytes except the last have bit 7 set, and the last byte has bit 7 clear. If the number is between 0 and 127, it is thus represented exactly as one byte.
Exceptions
Type Condition
ObjectDisposedException Method was called after the writer was disposed.
IOException An I/O error occurred on the underlying stream.

WriteWord(UInt16)

Writes a WORD value (16-bit unsigned integer) to the underlying stream and advances the current position by two bytes.
Declaration
public void WriteWord(ushort value)
Parameters
Type Name Description
UInt16 value WORD value to write.
Exceptions
Type Condition
ObjectDisposedException Method was called after the writer was disposed.
IOException An I/O error occurred on the underlying stream.

Implements