| Package | org.si.sion.effector |
| Class | public class SiEffectStream |
| Inheritance | SiEffectStream  Object |
| Property | Defined By | ||
|---|---|---|---|
| chain : Vector.<SiEffectBase> effector chain | SiEffectStream | ||
| pan : int panning of output (-64:L - 0:C - 64:R). | SiEffectStream | ||
| stream : SiOPMStream [read-only] stream buffer | SiEffectStream | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor, you should not create new EffectStream, you may call SiEffectModule.newLocalEffect() for these purpose. | SiEffectStream | ||
connectTo(output:SiOPMStream = null):void connect to another stream
| SiEffectStream | ||
free():void free all of effector chain, called when effector module is initialized | SiEffectStream | ||
getStreamSend(streamNum:int):Number get stream send. | SiEffectStream | ||
initialize(depth:int):void initialize, called when allocated | SiEffectStream | ||
parseMML(slot:int, mml:String, postfix:String):void Parse MML for effector
| SiEffectStream | ||
prepareProcess():int prepare for process | SiEffectStream | ||
process(startIndex:int, length:int, writeInStream:Boolean = true):int processing | SiEffectStream | ||
reset():void reset all parameters except for effector chain, called when effector module is initialized | SiEffectStream | ||
setAllStreamSendLevels(param:Vector.<int>):void set all stream send levels by Vector.<int>. | SiEffectStream | ||
setStreamSend(streamNum:int, volume:Number):void set stream send. | SiEffectStream | ||
| chain | property |
public var chain:Vector.<SiEffectBase>effector chain
| pan | property |
pan:intpanning of output (-64:L - 0:C - 64:R).
public function get pan():int public function set pan(value:int):void| stream | property |
stream:SiOPMStream [read-only] stream buffer
public function get stream():SiOPMStream| SiEffectStream | () | Constructor |
public function SiEffectStream(module:SiOPMModule, stream:SiOPMStream = null)Constructor, you should not create new EffectStream, you may call SiEffectModule.newLocalEffect() for these purpose.
Parametersmodule:SiOPMModule | |
stream:SiOPMStream (default = null) |
| connectTo | () | method |
public function connectTo(output:SiOPMStream = null):voidconnect to another stream
Parameters
output:SiOPMStream (default = null) |
| free | () | method |
public function free():voidfree all of effector chain, called when effector module is initialized
| getStreamSend | () | method |
public function getStreamSend(streamNum:int):Numberget stream send.
Parameters
streamNum:int — stream number[0-7]. The streamNum of 0 means master volume.
|
Number — send level[0-1].
|
| initialize | () | method |
public function initialize(depth:int):voidinitialize, called when allocated
Parameters
depth:int |
| parseMML | () | method |
public function parseMML(slot:int, mml:String, postfix:String):voidParse MML for effector
Parameters
slot:int — MML string.
| |
mml:String — Postfix string.
| |
postfix:String |
| prepareProcess | () | method |
public function prepareProcess():intprepare for process
Returnsint |
| process | () | method |
public function process(startIndex:int, length:int, writeInStream:Boolean = true):intprocessing
Parameters
startIndex:int | |
length:int | |
writeInStream:Boolean (default = true) |
int |
| reset | () | method |
public function reset():voidreset all parameters except for effector chain, called when effector module is initialized
| setAllStreamSendLevels | () | method |
public function setAllStreamSendLevels(param:Vector.<int>):voidset all stream send levels by Vector.<int>.
Parameters
param:Vector.<int> — Vector.<int>(8) of all volumes[0-128].
|
| setStreamSend | () | method |
public function setStreamSend(streamNum:int, volume:Number):voidset stream send.
Parameters
streamNum:int — stream number[0-7]. The streamNum of 0 means master volume.
| |
volume:Number — send level[0-1].
|