NAudio.Midi.TextEvent Class Reference

Represents a MIDI text event. More...

Inheritance diagram for NAudio.Midi.TextEvent:

Collaboration diagram for NAudio.Midi.TextEvent:

Public Member Functions
	TextEvent (BinaryReader br, int length)
	Reads a new text event from a MIDI stream.
	TextEvent (string text, MetaEventType metaEventType, long absoluteTime)
	Creates a new TextEvent.
override MidiEvent	Clone ()
	Creates a new instance of the TextEvent class that is a copy of the current instance.
override string	ToString ()
	Returns a string that represents the current object, including the base object's string representation and the value of the 'Text' property.
override void	Export (ref long absoluteTime, BinaryWriter writer)
	Exports the data to a BinaryWriter after performing the base export operation.
Public Member Functions inherited from NAudio.Midi.MetaEvent
	MetaEvent (MetaEventType metaEventType, int metaDataLength, long absoluteTime)
	Custom constructor for use by derived types, who will manage the data themselves.
override string	ToString ()
	Returns a string representation of the object, combining the AbsoluteTime and metaEvent properties.
Public Member Functions inherited from NAudio.Midi.MidiEvent
virtual int	GetAsShortMessage ()
	Returns the short message value calculated based on the channel and command code.
	MidiEvent (long absoluteTime, int channel, MidiCommandCode commandCode)
	Creates a MIDI event with specified parameters.
override string	ToString ()
	Returns a string representation of the current Midi event.

Properties
string	Text [get, set]
	The contents of this text event.
byte[]	Data [get, set]
	The raw contents of this text event.
Properties inherited from NAudio.Midi.MetaEvent
MetaEventType	MetaEventType [get]
	Gets the type of this meta event.
Properties inherited from NAudio.Midi.MidiEvent
virtual int	Channel [get, set]
	The MIDI Channel Number for this event (1-16)
int	DeltaTime [get]
	The Delta time for this event.
long	AbsoluteTime [get, set]
	The absolute time for this event.
MidiCommandCode	CommandCode [get]
	The command code for this event.

Private Attributes
byte[]	data

Additional Inherited Members
Static Public Member Functions inherited from NAudio.Midi.MetaEvent
static MetaEvent	ReadMetaEvent (BinaryReader br)
	Reads a meta event from the provided BinaryReader and returns the corresponding MetaEvent object.
Static Public Member Functions inherited from NAudio.Midi.MidiEvent
static MidiEvent	FromRawMessage (int rawMessage)
	Converts a raw MIDI message to a MidiEvent object.
static MidiEvent	ReadNextEvent (BinaryReader br, MidiEvent previous)
	Reads the next MIDI event from the BinaryReader and returns the corresponding MidiEvent.
static bool	IsNoteOff (MidiEvent midiEvent)
	Checks if the given MIDI event represents a Note Off message.
static bool	IsNoteOn (MidiEvent midiEvent)
	Checks if the provided MIDI event is a Note On event and returns true if the velocity is greater than 0.
static bool	IsEndTrack (MidiEvent midiEvent)
	Checks if the provided MIDI event is an end track event.
static int	ReadVarInt (BinaryReader br)
	Reads a variable-length encoded integer from the provided BinaryReader and returns the result.
static void	WriteVarInt (BinaryWriter writer, int value)
	Writes a variable-length encoded integer to the specified BinaryWriter.
Protected Member Functions inherited from NAudio.Midi.MetaEvent
	MetaEvent ()
	Empty constructor.
Protected Member Functions inherited from NAudio.Midi.MidiEvent
	MidiEvent ()
	Default constructor.

Detailed Description

Represents a MIDI text event.

Constructor & Destructor Documentation

TextEvent() [1/2]

NAudio.Midi.TextEvent.TextEvent ( BinaryReader br, int length )

inline

Reads a new text event from a MIDI stream.

Parameters

br	The MIDI stream
length	The data length

TextEvent() [2/2]

NAudio.Midi.TextEvent.TextEvent ( string text, MetaEventType metaEventType, long absoluteTime )

inline

Creates a new TextEvent.

Parameters

text	The text in this type
metaEventType	MetaEvent type (must be one that is associated with text data)
absoluteTime	Absolute time of this event

Member Function Documentation

Clone()

override MidiEvent NAudio.Midi.TextEvent.Clone ( )

virtual

Creates a new instance of the TextEvent class that is a copy of the current instance.

Returns

A new TextEvent that is a copy of this instance.

Reimplemented from NAudio.Midi.MetaEvent.

Export()

override void NAudio.Midi.TextEvent.Export ( ref long absoluteTime, BinaryWriter writer )

inlinevirtual

Exports the data to a BinaryWriter after performing the base export operation.

Parameters

absoluteTime	A reference to the absolute time.
writer	The BinaryWriter to which the data is exported.

This method performs the base export operation by calling the base class's Export method with the provided absoluteTime and writer . It then writes the data to the writer .

Reimplemented from NAudio.Midi.MetaEvent.

ToString()

override string NAudio.Midi.TextEvent.ToString ( )

inline

Returns a string that represents the current object, including the base object's string representation and the value of the 'Text' property.

Returns

A string that combines the string representation of the base object and the value of the 'Text' property.

This method overrides the default ToString method to provide a custom string representation of the current object. The returned string includes the string representation of the base object and the value of the 'Text' property.

Member Data Documentation

data

byte [] NAudio.Midi.TextEvent.data

private

Property Documentation

Data

byte [] NAudio.Midi.TextEvent.Data

getset

The raw contents of this text event.

Text

string NAudio.Midi.TextEvent.Text

getset

The contents of this text event.

---

The documentation for this class was generated from the following file:

• /Users/sumansaurabh/Documents/my-startup/xeno-rat/Plugins/LiveMicrophone/lib/NAudio.Midi/Midi/TextEvent.cs