NAudio.Midi.SmpteOffsetEvent Class Reference

SMPTE Offset Event. More...

Inheritance diagram for NAudio.Midi.SmpteOffsetEvent:

Collaboration diagram for NAudio.Midi.SmpteOffsetEvent:

Public Member Functions
	SmpteOffsetEvent (byte hours, byte minutes, byte seconds, byte frames, byte subFrames)
	Creates a new time signature event.
	SmpteOffsetEvent (BinaryReader br, int length)
	Reads a new time signature event from a MIDI stream.
override MidiEvent	Clone ()
	Creates a new instance of the SmpteOffsetEvent with the same property values as the current instance.
override string	ToString ()
	Returns a formatted string representing the time.
override void	Export (ref long absoluteTime, BinaryWriter writer)
	Exports the time data to a binary writer.
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	Hours [get]
	Hours.
int	Minutes [get]
	Minutes.
int	Seconds [get]
	Seconds.
int	Frames [get]
	Frames.
int	SubFrames [get]
	SubFrames.
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
readonly byte	hours
readonly byte	minutes
readonly byte	seconds
readonly byte	frames
readonly byte	subFrames

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

SMPTE Offset Event.

Constructor & Destructor Documentation

SmpteOffsetEvent() [1/2]

NAudio.Midi.SmpteOffsetEvent.SmpteOffsetEvent ( byte hours, byte minutes, byte seconds, byte frames, byte subFrames )

inline

Creates a new time signature event.

SmpteOffsetEvent() [2/2]

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

inline

Reads a new time signature event from a MIDI stream.

Parameters

br	The MIDI stream
length	The data length

Member Function Documentation

Clone()

override MidiEvent NAudio.Midi.SmpteOffsetEvent.Clone ( )

virtual

Creates a new instance of the SmpteOffsetEvent with the same property values as the current instance.

Returns

A new instance of SmpteOffsetEvent with the same property values as the current instance.

Reimplemented from NAudio.Midi.MetaEvent.

Export()

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

inlinevirtual

Exports the time data to a binary writer.

Parameters

absoluteTime	The absolute time value.
writer	The binary writer to which the time data is exported.

Exceptions

ArgumentNullException

Thrown when the writer is null.

This method exports the time data, including hours, minutes, seconds, frames, and subframes, to the specified binary writer.

Reimplemented from NAudio.Midi.MetaEvent.

ToString()

override string NAudio.Midi.SmpteOffsetEvent.ToString ( )

inline

Returns a formatted string representing the time.

Returns

A string formatted as "{base.ToString()} {hours}:{minutes}:{seconds}:{frames}:{subFrames}".

Member Data Documentation

frames

readonly byte NAudio.Midi.SmpteOffsetEvent.frames

private

hours

readonly byte NAudio.Midi.SmpteOffsetEvent.hours

private

minutes

readonly byte NAudio.Midi.SmpteOffsetEvent.minutes

private

seconds

readonly byte NAudio.Midi.SmpteOffsetEvent.seconds

private

subFrames

readonly byte NAudio.Midi.SmpteOffsetEvent.subFrames

private

Property Documentation

Frames

int NAudio.Midi.SmpteOffsetEvent.Frames

get

Frames.

Hours

int NAudio.Midi.SmpteOffsetEvent.Hours

get

Hours.

Minutes

int NAudio.Midi.SmpteOffsetEvent.Minutes

get

Minutes.

Seconds

int NAudio.Midi.SmpteOffsetEvent.Seconds

get

Seconds.

SubFrames

int NAudio.Midi.SmpteOffsetEvent.SubFrames

get

SubFrames.

---

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

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