org.si.sion.sequencer.SiMMLSequencer

	Property	Defined By
		callbackOnParsingSystemCommand : Function [write-only] function called back when parse system command.	SiMMLSequencer
		currentTrack : SiMMLTrack [read-only] Current working track	SiMMLSequencer
		isEnableChangeBPM : Boolean [read-only] Is enable to change BPM ?	SiMMLSequencer
		isFinished : Boolean [read-only] Is finish buffering ?	SiMMLSequencer
		isReadyToProcess : Boolean [read-only] Is ready to process ?	SiMMLSequencer
		isSequenceFinished : Boolean [read-only] Is finish executing sequence ?	SiMMLSequencer
		processedSampleCount : int [read-only] Processed sample count	SiMMLSequencer
		sampleRate : int Audio setting, sampling ratio.	MMLSequencer
		setting : MMLParserSetting MML parser setting.	MMLSequencer
		streamWritingBeat : int [read-only] current writing position (16beat count) in streaming buffer	SiMMLSequencer
		streamWritingPositionResidue : int [read-only] current writing position in streaming buffer, always less than length of streaming buffer	SiMMLSequencer
		title : String [read-only] Song title	SiMMLSequencer
		tracks : Vector.<SiMMLTrack> SiMMLTrack list	SiMMLSequencer

	Method	Defined By
		SiMMLSequencer(module:SiOPMModule, eventTriggerOn:Function, eventTriggerOff:Function, tempoChanged:Function) Create new sequencer.	SiMMLSequencer
		calcSampleDelay(sampleOffset:int = 0, beat16Offset:Number = 0, quant:Number = 0):Number calculate delay (in sample count) quantized by beat.	SiMMLSequencer
		calcSampleLength(beat16:Number):Number calculate length (in sample count).	SiMMLSequencer
		compile(interval:int = 1000):Number Parse mml string.	MMLSequencer
		dummyProcess(sampleCount:int):void Dummy process.	SiMMLSequencer
		getEventID(mmlCommand:String):int Get MMLEvent id by mml command letter.	MMLSequencer
		getEventLetter(eventID:int):String Get MML command letters by event id.	MMLSequencer
		prepareCompile(data:MMLData, mml:String):Boolean [override] Prepare to compile mml string.	SiMMLSequencer
		setGlobalSequence(seq:MMLSequence):void Set global sequence.	MMLSequencer

Protected Methods

	Method		Defined By
		_default_onGlobalWait(e:MMLEvent):MMLEvent default operation for MMLEvent.GLOBAL_WAIT.	MMLSequencer
		_default_onInternalCall(e:MMLEvent):MMLEvent default operation for MMLEvent.INTERNAL_CALL.	MMLSequencer
		_default_onInternalWait(e:MMLEvent):MMLEvent default operation for MMLEvent.INTERNAL_WAIT.	MMLSequencer
		_default_onNoOperation(e:MMLEvent):MMLEvent default operation for MMLEvent.NOP.	MMLSequencer
		_default_onProcess(e:MMLEvent):MMLEvent default operation for MMLEvent.PROCESS.	MMLSequencer
		_default_onRepeatAll(e:MMLEvent):MMLEvent default operation for MMLEvent.REPEAT_ALL.	MMLSequencer
		_default_onRepeatBegin(e:MMLEvent):MMLEvent default operation for MMLEvent.REPEAT_BEGIN.	MMLSequencer
		_default_onRepeatBreak(e:MMLEvent):MMLEvent default operation for MMLEvent.REPEAT_BREAK.	MMLSequencer
		_default_onRepeatEnd(e:MMLEvent):MMLEvent default operation for MMLEvent.REPEAT_END.	MMLSequencer
		_default_onSequenceTail(e:MMLEvent):MMLEvent default operation for MMLEvent.SEQUENCE_TAIL.	MMLSequencer
		_default_onTempo(e:MMLEvent):MMLEvent default operation for MMLEvent.TEMPO.	MMLSequencer
		_default_onTimer(e:MMLEvent):MMLEvent default operation for MMLEvent.TIMER.	MMLSequencer
		_dummy_onProcess(e:MMLEvent):MMLEvent dummy operation for MMLEvent.PROCESS.	MMLSequencer
		_nop(e:MMLEvent):MMLEvent Operates nothing.	MMLSequencer
		executeGlobalSequence():int execute global sequence.	MMLSequencer
		isEndGlobalSequence():Boolean check global sequences pointer acheives to the end.	MMLSequencer
		newMMLEventListener(letter:String, func:Function, isGlobal:Boolean = false):int Register new MMLEvent letter.	MMLSequencer
		onAfterCompile(seqGroup:MMLSequenceGroup):void Callback after parse.	MMLSequencer
		onBeat(delaySamples:int, beatCounter:int):void Callback on every 16th beats.	MMLSequencer
		onBeforeCompile(mml:String):String Callback before parse.	MMLSequencer
		onProcess(length:int, e:MMLEvent):void Callback on processing.	MMLSequencer
		onTableParse(prev:MMLEvent, table:String):void Callback when table event was found.	MMLSequencer
		onTempoChanged(tempoRatio:Number):void Callback when the tempo is changed.	MMLSequencer
		onTimerInterruption():void Callback when streaming interrupted by timer .	MMLSequencer
		processMMLExecutor(exe:MMLExecutor, bufferSampleCount:int):Boolean Processing audio by one executor.	MMLSequencer
		setMMLEventListener(id:int, func:Function, isGlobal:Boolean = false):void Similar with an addEventListener(), but only one listener can be set for one event.	MMLSequencer
		startGlobalSequence():void start global sequence.	MMLSequencer

	Constant	Defined By
		FIXED_BITS : int = 8 [static] bits for fixed decimal	MMLSequencer
		FIXED_FILTER : int [static] filter for decimal fraction area	MMLSequencer

Property Detail

callbackOnParsingSystemCommand

property

callbackOnParsingSystemCommand:Function [write-only]

function called back when parse system command. The function type is function(data:SiMMLData, command: : Boolean. Return false to append the command to SiONData.systemCommands.

Implementation
public function set callbackOnParsingSystemCommand(value:Function):void

currentTrack

property

currentTrack:SiMMLTrack [read-only]

Current working track

Implementation
public function get currentTrack():SiMMLTrack

isEnableChangeBPM

property

isEnableChangeBPM:Boolean [read-only]

Is enable to change BPM ?

Implementation
public function get isEnableChangeBPM():Boolean

isFinished

property

isFinished:Boolean [read-only]

Is finish buffering ?

Implementation
public function get isFinished():Boolean

isReadyToProcess

property

isReadyToProcess:Boolean [read-only]

Is ready to process ?

Implementation
public function get isReadyToProcess():Boolean

isSequenceFinished

property

isSequenceFinished:Boolean [read-only]

Is finish executing sequence ?

Implementation
public function get isSequenceFinished():Boolean

processedSampleCount

property

processedSampleCount:int [read-only]

Processed sample count

Implementation
public function get processedSampleCount():int

streamWritingBeat

property

streamWritingBeat:int [read-only]

current writing position (16beat count) in streaming buffer

Implementation
public function get streamWritingBeat():int

streamWritingPositionResidue

property

streamWritingPositionResidue:int [read-only]

current writing position in streaming buffer, always less than length of streaming buffer

Implementation
public function get streamWritingPositionResidue():int

title

property

title:String [read-only]

Song title

Implementation
public function get title():String

tracks

property

public var tracks:Vector.<SiMMLTrack>

SiMMLTrack list

Constructor Detail

SiMMLSequencer

()

Constructor

public function SiMMLSequencer(module:SiOPMModule, eventTriggerOn:Function, eventTriggerOff:Function, tempoChanged:Function)

Create new sequencer.

Parameters

	`module:SiOPMModule`

	`eventTriggerOn:Function`

	`eventTriggerOff:Function`

	`tempoChanged:Function`

Method Detail

_setBeatCallbackFilter

()

method

_sion_internal function _setBeatCallbackFilter(filter:int):void

SiONTrackEvent.BEAT is called if (beatCount16th & onBeatCallbackFilter) == 0.

Parameters

filter:int

calcSampleDelay

()

method

public function calcSampleDelay(sampleOffset:int = 0, beat16Offset:Number = 0, quant:Number = 0):Number

calculate delay (in sample count) quantized by beat.

Parameters

	`sampleOffset:int` (default = `0`) — Offset in sample count.

	`beat16Offset:Number` (default = `0`) — Offset in 16th beat.

	`quant:Number` (default = `0`) — Quantizing beat in 16th. The 0 sets no quantization, 1 sets quantization by 16th, 4 sets quantization by 4th beat.

Returns

Number

calcSampleLength

()

method

public function calcSampleLength(beat16:Number):Number

calculate length (in sample count).

Parameters

beat16:Number — The beat number in 16th calculating from.

Returns

Number

dummyProcess

()

method

public function dummyProcess(sampleCount:int):void

Dummy process. This funciton must be called after prepareProcess().

Parameters

sampleCount:int — dumming sample count. [NOTICE] This value is rounded by a buffer length. Not an exact value.

prepareCompile

()

method

override public function prepareCompile(data:MMLData, mml:String):Boolean

Prepare to compile mml string. Calls onBeforeCompile() inside.

Parameters

	`data:MMLData` — Data instance.

	`mml:String` — MML String.

Returns

Boolean — Returns false when it's not necessary to compile.

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

SiON version 0.66 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
SiMMLSequencer	Properties \| Methods \| Constants

Package	org.si.sion.sequencer
Class	public class SiMMLSequencer
Inheritance	SiMMLSequencer MMLSequencer Object