Packageorg.si.sion.module
Classpublic class SiOPMWaveSamplerData
InheritanceSiOPMWaveSamplerData Inheritance SiOPMWaveBase Inheritance Object

SiOPM samplers wave data



Public Properties
 PropertyDefined By
  channelCount : int
[read-only] channel count of this data.
SiOPMWaveSamplerData
  endPoint : int
[read-only] wave end position in sample count.
SiOPMWaveSamplerData
  extractThreshold : int = 4000
[static] maximum length limit to extract Sound [ms]
SiOPMWaveSamplerData
  ignoreNoteOff : Boolean
flag to ignore note off.
SiOPMWaveSamplerData
  isExtracted : Boolean
[read-only] Is extracted ?
SiOPMWaveSamplerData
  length : int
[read-only] Sammple length
SiOPMWaveSamplerData
  loopPoint : int
[read-only] wave looping position in sample count.
SiOPMWaveSamplerData
 InheritedmoduleType : int
module type
SiOPMWaveBase
  pan : int
[read-only] pan [-64 - 64]
SiOPMWaveSamplerData
  peakList : Vector.<Number>
[read-only] peak list only available for extracted data
SiOPMWaveSamplerData
  soundData : Sound
[read-only] Sound data
SiOPMWaveSamplerData
  startPoint : int
[read-only] wave starting position in sample count.
SiOPMWaveSamplerData
  waveData : Vector.<Number>
[read-only] Wave data
SiOPMWaveSamplerData
Public Methods
 MethodDefined By
  
SiOPMWaveSamplerData(data:* = null, ignoreNoteOff:Boolean = false, pan:int = 0, srcChannelCount:int = 2, channelCount:int = 0, peakList:Vector.<Number> = null)
constructor
SiOPMWaveSamplerData
  
construct peak list,
SiOPMWaveSamplerData
  
extract():void
extract Sound data.
SiOPMWaveSamplerData
  
getInitialSampleIndex(phase:Number = 0):int
Get initial sample index.
SiOPMWaveSamplerData
  
initialize(data:*, ignoreNoteOff:Boolean = false, pan:int = 0, srcChannelCount:int = 2, channelCount:int = 0, peakList:Vector.<Number> = null):SiOPMWaveSamplerData
initialize
SiOPMWaveSamplerData
  
slice(startPoint:int = -1, endPoint:int = -1, loopPoint:int = -1):SiOPMWaveSamplerData
Slicer setting.
SiOPMWaveSamplerData
Property Detail
channelCountproperty
channelCount:int  [read-only]

channel count of this data.


Implementation
    public function get channelCount():int
endPointproperty 
endPoint:int  [read-only]

wave end position in sample count. you can set this property by slice().


Implementation
    public function get endPoint():int

See also

extractThresholdproperty 
public static var extractThreshold:int = 4000

maximum length limit to extract Sound [ms]

ignoreNoteOffproperty 
ignoreNoteOff:Boolean

flag to ignore note off. set true to ignore note off (one shot voice). this flag is only available for non-loop samples.


Implementation
    public function get ignoreNoteOff():Boolean
    public function set ignoreNoteOff(value:Boolean):void
isExtractedproperty 
isExtracted:Boolean  [read-only]

Is extracted ?


Implementation
    public function get isExtracted():Boolean
lengthproperty 
length:int  [read-only]

Sammple length


Implementation
    public function get length():int
loopPointproperty 
loopPoint:int  [read-only]

wave looping position in sample count. -1 means no repeat. you can set this property by slice().


Implementation
    public function get loopPoint():int

See also

panproperty 
pan:int  [read-only]

pan [-64 - 64]


Implementation
    public function get pan():int
peakListproperty 
peakList:Vector.<Number>  [read-only]

peak list only available for extracted data


Implementation
    public function get peakList():Vector.<Number>
soundDataproperty 
soundData:Sound  [read-only]

Sound data


Implementation
    public function get soundData():Sound
startPointproperty 
startPoint:int  [read-only]

wave starting position in sample count. you can set this property by slice().


Implementation
    public function get startPoint():int

See also

waveDataproperty 
waveData:Vector.<Number>  [read-only]

Wave data


Implementation
    public function get waveData():Vector.<Number>
Constructor Detail
SiOPMWaveSamplerData()Constructor
public function SiOPMWaveSamplerData(data:* = null, ignoreNoteOff:Boolean = false, pan:int = 0, srcChannelCount:int = 2, channelCount:int = 0, peakList:Vector.<Number> = null)

constructor

Parameters
data:* (default = null) — wave data, Sound, Vector.<Number> or Vector.<int> is available. The Sound is extracted when the length is shorter than SiOPMWaveSamplerData.extractThreshold[msec].
 
ignoreNoteOff:Boolean (default = false) — flag to ignore note off
 
pan:int (default = 0) — pan of this sample [-64 - 64].
 
srcChannelCount:int (default = 2) — channel count of source data, this argument is only available when data type is Vector.<Number>.
 
channelCount:int (default = 0) — channel count of this data, 0 sets same with srcChannelCount
 
peakList:Vector.<Number> (default = null) — peak list for time stretching
Method Detail
constructPeakList()method
public function constructPeakList():PeakDetector

construct peak list,

Returns
PeakDetector
extract()method 
public function extract():void

extract Sound data. The sound data shooter than extractThreshold is already extracted. [CAUTION] Long sound takes long time to extract and consumes large memory area.

See also

extractThreshold
getInitialSampleIndex()method 
public function getInitialSampleIndex(phase:Number = 0):int

Get initial sample index.

Parameters

phase:Number (default = 0) — Starting phase, ratio from start point to end point(0-1).

Returns
int
initialize()method 
public function initialize(data:*, ignoreNoteOff:Boolean = false, pan:int = 0, srcChannelCount:int = 2, channelCount:int = 0, peakList:Vector.<Number> = null):SiOPMWaveSamplerData

initialize

Parameters

data:* — wave data, Sound, Vector.<Number> or Vector.<int> is available. The Sound is extracted when the length is shorter than SiOPMWaveSamplerData.extractThreshold[msec].
 
ignoreNoteOff:Boolean (default = false) — flag to ignore note off
 
pan:int (default = 0) — pan of this sample.
 
srcChannelCount:int (default = 2) — channel count of source data, this argument is only available when data type is Vector.<Number>.
 
channelCount:int (default = 0) — channel count of this data, 0 sets same with srcChannelCount. This argument is ignored when the data is not extracted.
 
peakList:Vector.<Number> (default = null)

Returns
SiOPMWaveSamplerData — this instance.

See also

slice()method 
public function slice(startPoint:int = -1, endPoint:int = -1, loopPoint:int = -1):SiOPMWaveSamplerData

Slicer setting. You can cut samples and set repeating.

Parameters

startPoint:int (default = -1) — slicing point to start data.The negative value skips head silence.
 
endPoint:int (default = -1) — slicing point to end data. The negative value plays whole data.
 
loopPoint:int (default = -1) — slicing point to repeat data. The negative value sets no repeat.

Returns
SiOPMWaveSamplerData — this instance.