| Package | org.si.sion.module |
| Class | public class SiOPMWaveSamplerData |
| Inheritance | SiOPMWaveSamplerData SiOPMWaveBase Object |
| Property | Defined 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 | ||
![]() | moduleType : 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 | ||
| Method | Defined 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 | ||
| channelCount | property |
channelCount:int [read-only] channel count of this data.
public function get channelCount():int| endPoint | property |
endPoint:int [read-only] wave end position in sample count. you can set this property by slice().
public function get endPoint():intSee also
| extractThreshold | property |
public static var extractThreshold:int = 4000maximum length limit to extract Sound [ms]
| ignoreNoteOff | property |
ignoreNoteOff:Booleanflag to ignore note off. set true to ignore note off (one shot voice). this flag is only available for non-loop samples.
public function get ignoreNoteOff():Boolean public function set ignoreNoteOff(value:Boolean):void| isExtracted | property |
isExtracted:Boolean [read-only] Is extracted ?
public function get isExtracted():Boolean| length | property |
length:int [read-only] Sammple length
public function get length():int| loopPoint | property |
loopPoint:int [read-only] wave looping position in sample count. -1 means no repeat. you can set this property by slice().
public function get loopPoint():intSee also
| pan | property |
pan:int [read-only] pan [-64 - 64]
public function get pan():int| peakList | property |
peakList:Vector.<Number> [read-only] peak list only available for extracted data
public function get peakList():Vector.<Number>| soundData | property |
soundData:Sound [read-only] Sound data
public function get soundData():Sound| startPoint | property |
startPoint:int [read-only] wave starting position in sample count. you can set this property by slice().
public function get startPoint():intSee also
| waveData | property |
waveData:Vector.<Number> [read-only] Wave data
public function get waveData():Vector.<Number>| SiOPMWaveSamplerData | () | Constructor |
public function SiOPMWaveSamplerData(data:* = null, ignoreNoteOff:Boolean = false, pan:int = 0, srcChannelCount:int = 2, channelCount:int = 0, peakList:Vector.<Number> = null)constructor
Parametersdata:* (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
|
| constructPeakList | () | method |
| extract | () | method |
public function extract():voidextract 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
| getInitialSampleIndex | () | method |
public function getInitialSampleIndex(phase:Number = 0):intGet initial sample index.
Parameters
phase:Number (default = 0) — Starting phase, ratio from start point to end point(0-1).
|
int |
| initialize | () | method |
public function initialize(data:*, ignoreNoteOff:Boolean = false, pan:int = 0, srcChannelCount:int = 2, channelCount:int = 0, peakList:Vector.<Number> = null):SiOPMWaveSamplerDatainitialize
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) |
SiOPMWaveSamplerData — this instance.
|
See also
| slice | () | method |
public function slice(startPoint:int = -1, endPoint:int = -1, loopPoint:int = -1):SiOPMWaveSamplerDataSlicer 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.
|
SiOPMWaveSamplerData — this instance.
|