Xeno-rat
Loading...
Searching...
No Matches
Public Member Functions | Properties | Private Attributes | List of all members
NAudio.Midi.TempoEvent Class Reference

Represents a MIDI tempo event. More...

Inheritance diagram for NAudio.Midi.TempoEvent:
Collaboration diagram for NAudio.Midi.TempoEvent:

Public Member Functions

 TempoEvent (BinaryReader br, int length)
 Reads a new tempo event from a MIDI stream.
 
 TempoEvent (int microsecondsPerQuarterNote, long absoluteTime)
 Creates a new tempo event with specified settings.
 
override MidiEvent Clone ()
 Creates a new instance of the TempoEvent class that is a copy of the current instance.
 
override string ToString ()
 Returns a string representation of the object.
 
override void Export (ref long absoluteTime, BinaryWriter writer)
 Exports the current object to a binary writer, including the microseconds per quarter note.
 
- 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

int MicrosecondsPerQuarterNote [get, set]
 Microseconds per quarter note.
 
double Tempo [get, set]
 Tempo.
 
- 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

int microsecondsPerQuarterNote
 

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 tempo event.

Constructor & Destructor Documentation

◆ TempoEvent() [1/2]

NAudio.Midi.TempoEvent.TempoEvent ( BinaryReader br,
int length )
inline

Reads a new tempo event from a MIDI stream.

Parameters
brThe MIDI stream
lengththe data length

◆ TempoEvent() [2/2]

NAudio.Midi.TempoEvent.TempoEvent ( int microsecondsPerQuarterNote,
long absoluteTime )
inline

Creates a new tempo event with specified settings.

Parameters
microsecondsPerQuarterNoteMicroseconds per quarter note
absoluteTimeAbsolute time

Member Function Documentation

◆ Clone()

override MidiEvent NAudio.Midi.TempoEvent.Clone ( )
virtual

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

Returns
A new instance of the TempoEvent class that is a copy of the current instance.

Reimplemented from NAudio.Midi.MetaEvent.

◆ Export()

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

Exports the current object to a binary writer, including the microseconds per quarter note.

Parameters
absoluteTimeThe absolute time value.
writerThe binary writer to which the object is exported.

This method exports the current object to the specified binary writer, including the microseconds per quarter note. It first calls the base class's Export method to export the base object, then writes the microseconds per quarter note to the writer in little-endian format using three bytes.

Reimplemented from NAudio.Midi.MetaEvent.

◆ ToString()

override string NAudio.Midi.TempoEvent.ToString ( )
inline

Returns a string representation of the object.

Returns
A string containing the object's name, beats per minute, and calculated tempo.

This method returns a formatted string that includes the object's name, beats per minute, and calculated tempo based on the microseconds per quarter note. The tempo is calculated using the formula: 60000000 / microsecondsPerQuarterNote.

Member Data Documentation

◆ microsecondsPerQuarterNote

int NAudio.Midi.TempoEvent.microsecondsPerQuarterNote
private

Property Documentation

◆ MicrosecondsPerQuarterNote

int NAudio.Midi.TempoEvent.MicrosecondsPerQuarterNote
getset

Microseconds per quarter note.

◆ Tempo

double NAudio.Midi.TempoEvent.Tempo
getset

Tempo.

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