Packageorg.si.sion.sequencer.base
Classpublic class MMLParser
InheritanceMMLParser Inheritance Object

MML parser class.


Public Properties
 PropertyDefined By
  keySign : String
[static] [write-only] Key signiture for all notes.
MMLParser
  parseProgress : Number
[static] [read-only] Parsing progression (0-1).
MMLParser
Public Methods
 MethodDefined By
  
MMLParser()
constructer do nothing.
MMLParser
  
addMMLEvent(id:int, data:int = 0, length:int = 0, noteOption:Boolean = false):MMLEvent
[static]
MMLParser
  
errorKeySign(ksign:String):Error
[static]
MMLParser
  
errorNoteOutofRange(note:int):Error
[static]
MMLParser
  
errorRangeOver(cmd:String, min:int, max:int):Error
[static]
MMLParser
  
errorStacOverflow(cmd:String):Error
[static]
MMLParser
  
errorStacUnderflow(cmd:String):Error
[static]
MMLParser
  
errorSyntax(syn:String):Error
[static]
MMLParser
  
errorUnknown(n:String):Error
[static]
MMLParser
  
getEventID(mmlCommand:String):int
[static] Get MMLEvent id by mml command letter.
MMLParser
  
parse(interrupt:int = 0):MMLEvent
[static] Parse mml string.
MMLParser
  
prepareParse(setting:MMLParserSetting, mml:String):void
[static] Prepare to parse.
MMLParser
Property Detail
keySignproperty
keySign:String  [write-only]

Key signiture for all notes. The letter for key signiture is expressed as /[A-G][+\-#b]?m?/.


Implementation
    public static function set keySign(value:String):void
parseProgressproperty 
parseProgress:Number  [read-only]

Parsing progression (0-1).


Implementation
    public static function get parseProgress():Number
Constructor Detail
MMLParser()Constructor
public function MMLParser()

constructer do nothing.

Method Detail
addMMLEvent()method
public static function addMMLEvent(id:int, data:int = 0, length:int = 0, noteOption:Boolean = false):MMLEvent

Parameters

id:int
 
data:int (default = 0)
 
length:int (default = 0)
 
noteOption:Boolean (default = false)

Returns
MMLEvent
errorKeySign()method 
public static function errorKeySign(ksign:String):Error

Parameters

ksign:String

Returns
Error
errorNoteOutofRange()method 
public static function errorNoteOutofRange(note:int):Error

Parameters

note:int

Returns
Error
errorRangeOver()method 
public static function errorRangeOver(cmd:String, min:int, max:int):Error

Parameters

cmd:String
 
min:int
 
max:int

Returns
Error
errorStacOverflow()method 
public static function errorStacOverflow(cmd:String):Error

Parameters

cmd:String

Returns
Error
errorStacUnderflow()method 
public static function errorStacUnderflow(cmd:String):Error

Parameters

cmd:String

Returns
Error
errorSyntax()method 
public static function errorSyntax(syn:String):Error

Parameters

syn:String

Returns
Error
errorUnknown()method 
public static function errorUnknown(n:String):Error

Parameters

n:String

Returns
Error
getEventID()method 
public static function getEventID(mmlCommand:String):int

Get MMLEvent id by mml command letter.

Parameters

mmlCommand:String — letter of MML command.

Returns
int — Event id. Returns 0 if not found.
parse()method 
public static function parse(interrupt:int = 0):MMLEvent

Parse mml string.

Parameters

interrupt:int (default = 0) — Interrupting interval [ms]. 0 means no interruption. The interrupt appears between each sequence.

Returns
MMLEvent — Returns head MMLEvent. The return value of null means no head event.
prepareParse()method 
public static function prepareParse(setting:MMLParserSetting, mml:String):void

Prepare to parse.

Parameters

setting:MMLParserSetting — MML String.
 
mml:String




© 2009-2014 keim_at_si

Fri Jan 22 2016, 07:46 PM +09:00