| Package | org.si.sion.effector |
| Class | public class SiEffectBase |
| Inheritance | SiEffectBase  Object |
| Subclasses | SiCompositeEffector, SiCtrlFilterBase, SiEffectAutoPan, SiEffectCompressor, SiEffectDistortion, SiEffectDownSampler, SiEffectEqualiser, SiEffectSpeakerSimulator, SiEffectStereoChorus, SiEffectStereoDelay, SiEffectStereoExpander, SiEffectStereoReverb, SiEffectWaveShaper, SiFilterBase, SiFilterVowel |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | SiEffectBase | ||
initialize():void Initializer. | SiEffectBase | ||
mmlCallback(args:Vector.<Number>):void Parameter setting by mml arguments. | SiEffectBase | ||
prepareProcess():int Prepare processing. | SiEffectBase | ||
process(channels:int, buffer:Vector.<Number>, startIndex:int, length:int):int Process effect to stream buffer. | SiEffectBase | ||
| SiEffectBase | () | Constructor |
public function SiEffectBase()Constructor. do nothing.
| initialize | () | method |
public function initialize():voidInitializer. The system calls this when the instance is created.
| mmlCallback | () | method |
public function mmlCallback(args:Vector.<Number>):voidParameter setting by mml arguments. The sequencer calls this when "#EFFECT" appears.
Parameters
args:Vector.<Number> — The arguments refer from mml. The value of Number.NaN is put when its abbriviated.
|
| prepareProcess | () | method |
public function prepareProcess():intPrepare processing. The system calls this before processing.
Returnsint — requesting channels count.
|
| process | () | method |
public function process(channels:int, buffer:Vector.<Number>, startIndex:int, length:int):intProcess effect to stream buffer. The system calls this to process.
Parameters
channels:int — Stream channel count. 1=monoral(same data in buffer[i] and buffer[i+1]). 2=stereo.
| |
buffer:Vector.<Number> — Stream buffer to apply effect. The order is same as wave format [L0,R0,L1,R1,L2,R2 ... ].
| |
startIndex:int — startIndex to apply effect. You CANNOT use this index to the stream buffer directly. Should be doubled because its a stereo stream.
| |
length:int — length to apply effect. You CANNOT use this length to the stream buffer directly. Should be doubled because its a stereo stream.
|
int — output channels count.
|