AudioHelm.Note Class Reference

Representation of a note in a sequencer. Changing the values in this object will change them in the sequencer. More...

Inheritance diagram for AudioHelm.Note:

Public Member Functions
delegate void	NoteAction (Note note)
	A note event. More...
void	OnAfterDeserialize ()
void	OnBeforeSerialize ()
void	TriggerNoteOnEvent ()
	Sends out a note on event to all listeners. More...
void	TriggerNoteOffEvent ()
	Sends out a note off event to all listeners. More...
void	TryCreate ()
	Tries to create a native note representation if one doesn't exist already. More...
void	TryDelete ()
	Tries to delete the native note representation. More...
bool	OverlapsRange (float rangeStart, float rangeEnd)
	Checks if this note overlaps a sequencer range. More...
bool	InsideRange (float rangeStart, float rangeEnd)
	Checks if this note is contained withing a sequencer range More...
void	RemoveRange (float rangeStart, float rangeEnd)
	Removes part of the note on/off range that is contained withing the specified range. More...

Public Attributes
Sequencer	parent
	The sequencer this note belongs to. More...

Properties
int	note [get, set]
	The MIDI note to play. More...
float	start [get, set]
	The note on time measured in sixteenth notes. More...
float	end [get, set]
	The note off time measured in sixteenth notes. More...
float	velocity [get, set]
	The velocity of key press (how hard the note is hit). [0.0, 1.0] More...

Events
NoteAction	OnNoteOn
	Event hook for a note on event. More...
NoteAction	OnNoteOff
	Event hook for a note off event. More...

Detailed Description

Representation of a note in a sequencer. Changing the values in this object will change them in the sequencer.

Member Function Documentation

InsideRange()

bool AudioHelm.Note.InsideRange	(	float	rangeStart,
		float	rangeEnd
	)

Checks if this note is contained withing a sequencer range

Returns

true, if note overlaps the range, false otherwise.

Parameters

rangeStart	Start of the range.
rangeEnd	End of the range.

NoteAction()

delegate void AudioHelm.Note.NoteAction

(

Note

note

)

A note event.

Parameters

note	The Note object that triggered the event.

OverlapsRange()

bool AudioHelm.Note.OverlapsRange	(	float	rangeStart,
		float	rangeEnd
	)

Checks if this note overlaps a sequencer range.

Returns

true, if note overlaps the range, false otherwise.

Parameters

rangeStart	Start of the range.
rangeEnd	End of the range.

RemoveRange()

void AudioHelm.Note.RemoveRange	(	float	rangeStart,
		float	rangeEnd
	)

Removes part of the note on/off range that is contained withing the specified range.

Parameters

rangeStart	Start of the range to remove.
rangeEnd	End of the range to remove.

TriggerNoteOffEvent()

void AudioHelm.Note.TriggerNoteOffEvent

(

)

Sends out a note off event to all listeners.

TriggerNoteOnEvent()

void AudioHelm.Note.TriggerNoteOnEvent

(

)

Sends out a note on event to all listeners.

TryCreate()

void AudioHelm.Note.TryCreate

(

)

Tries to create a native note representation if one doesn't exist already.

TryDelete()

void AudioHelm.Note.TryDelete

(

)

Tries to delete the native note representation.

Member Data Documentation

parent

Sequencer AudioHelm.Note.parent

The sequencer this note belongs to.

Property Documentation

end

float AudioHelm.Note.end

getset

The note off time measured in sixteenth notes.

note

int AudioHelm.Note.note

getset

The MIDI note to play.

start

float AudioHelm.Note.start

getset

The note on time measured in sixteenth notes.

velocity

float AudioHelm.Note.velocity

getset

The velocity of key press (how hard the note is hit). [0.0, 1.0]

Event Documentation

OnNoteOff

NoteAction AudioHelm.Note.OnNoteOff

Event hook for a note off event.

OnNoteOn

NoteAction AudioHelm.Note.OnNoteOn

Event hook for a note on event.

---

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

• AudioHelm/Scripts/Note.cs