Packageorg.si.sion.utils
Classpublic class BPMAnalyzer
InheritanceBPMAnalyzer Inheritance Object

BPMAnalyzer analyzes beat per minute value of music



Public Properties
 PropertyDefined By
  bpm : int
[read-only] estimated bpm
BPMAnalyzer
  bpmProbability : Number
[read-only] estimated bpm's probability
BPMAnalyzer
  filterbanks : Vector.<PeakDetector>
filter banks, 5000Hz, 2400Hz, 100Hz
BPMAnalyzer
  pickedupBPMList : Vector.<int>
[read-only] picked up bpm list
BPMAnalyzer
  pickedupBPMProbabilityList : Vector.<Number>
[read-only] picked up bpm's probability list
BPMAnalyzer
  pickedupCount : int
[read-only] number of picked up point
BPMAnalyzer
  snapShotPosition : Number
[read-only] starting position that has maximum probability
BPMAnalyzer
Public Methods
 MethodDefined By
  
BPMAnalyzer(filterbankCount:int = 3)
constructor
BPMAnalyzer
  
estimateBPM(sound:Sound, rememberFilterbanksSnapShot:Boolean = false):int
estimate BPM from Sound
BPMAnalyzer
  
estimateBPMFromSamples(sample:Vector.<Number>, channels:int):int
estimate BPM from samples
BPMAnalyzer
Property Detail
bpmproperty
bpm:int  [read-only]

estimated bpm


Implementation
    public function get bpm():int
bpmProbabilityproperty 
bpmProbability:Number  [read-only]

estimated bpm's probability


Implementation
    public function get bpmProbability():Number
filterbanksproperty 
public var filterbanks:Vector.<PeakDetector>

filter banks, 5000Hz, 2400Hz, 100Hz

pickedupBPMListproperty 
pickedupBPMList:Vector.<int>  [read-only]

picked up bpm list


Implementation
    public function get pickedupBPMList():Vector.<int>
pickedupBPMProbabilityListproperty 
pickedupBPMProbabilityList:Vector.<Number>  [read-only]

picked up bpm's probability list


Implementation
    public function get pickedupBPMProbabilityList():Vector.<Number>
pickedupCountproperty 
pickedupCount:int  [read-only]

number of picked up point


Implementation
    public function get pickedupCount():int
snapShotPositionproperty 
snapShotPosition:Number  [read-only]

starting position that has maximum probability


Implementation
    public function get snapShotPosition():Number
Constructor Detail
BPMAnalyzer()Constructor
public function BPMAnalyzer(filterbankCount:int = 3)

constructor

Parameters
filterbankCount:int (default = 3) — Number of filter bank for analysis (1-4).
Method Detail
estimateBPM()method
public function estimateBPM(sound:Sound, rememberFilterbanksSnapShot:Boolean = false):int

estimate BPM from Sound

Parameters

sound:Sound — sound to analyze
 
rememberFilterbanksSnapShot:Boolean (default = false) — remember filterbanks status that has the biggest probability

Returns
int — estimated bpm value
estimateBPMFromSamples()method 
public function estimateBPMFromSamples(sample:Vector.<Number>, channels:int):int

estimate BPM from samples

Parameters

sample:Vector.<Number> — samples to analyze
 
channels:int — channel count of samples

Returns
int — estimated bpm value