API VolumeMeter

Simulate a volume meter for visual feedback

• Fields
  • level
  • time
  • cursor
  • envelope
  • entropy
  • gain
• Functions
  • Musician.VolumeMeter.create
  • Musician.VolumeMeter:Reset
  • Musician.VolumeMeter:NoteOn
  • Musician.VolumeMeter:NoteOff
  • Musician.VolumeMeter:GetLevel
  • Musician.VolumeMeter:AddElapsed

Fields

• level (number) Current level
• time (number) Current time, from noteOn
• cursor (number) Cursor envelope position
• envelope (table) Envelope points (time, level)
• entropy (number) Vibration entropy
• gain (number) Overall gain to be applied to the level

Functions

Musician.VolumeMeter.create

Volume meter

Musician.VolumeMeter.create()

Musician.VolumeMeter:Reset

Reset

Musician.VolumeMeter:Reset()

Musician.VolumeMeter:NoteOn

Note on

Musician.VolumeMeter:NoteOn(instrument, key)

Arguments

• instrument (table) instrument data from Musician.INSTRUMENTS
• key (int) MIDI key number (optional)

Musician.VolumeMeter:NoteOff

Note off

Musician.VolumeMeter:NoteOff()

Musician.VolumeMeter:GetLevel

Get current level

level = Musician.VolumeMeter:GetLevel()

Returns

• level (number)

Musician.VolumeMeter:AddElapsed

Add elapsed seconds after previous frame

Musician.VolumeMeter:AddElapsed(elapsed)

Arguments

• elapsed (number)