BeatTracker
Defined in: packages/pleco-xa/src/scripts/xa-beat-tracker.js:804
Stateful convenience wrapper around the canonical engine. All numerical work happens in the module-level functions above.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BeatTracker():
BeatTracker
Defined in: packages/pleco-xa/src/scripts/xa-beat-tracker.js:805
Returns
Section titled “Returns”BeatTracker
Properties
Section titled “Properties”tempoHint
Section titled “tempoHint”tempoHint:
number
Defined in: packages/pleco-xa/src/scripts/xa-beat-tracker.js:807
Methods
Section titled “Methods”beatTrack()
Section titled “beatTrack()”beatTrack(
options?):object
Defined in: packages/pleco-xa/src/scripts/xa-beat-tracker.js:832
Beat tracking (options-object API).
Parameters
Section titled “Parameters”options?
Section titled “options?”any = {}
{y, sr, onsetEnvelope, hopLength, startBpm, tightness, trim, bpm, units, sparse} — see beat_track()
Returns
Section titled “Returns”object
beats:
any[]
tempo:
number
onsetStrength()
Section titled “onsetStrength()”onsetStrength(
y,sr?,hopLength?):Float32Array<ArrayBufferLike>
Defined in: packages/pleco-xa/src/scripts/xa-beat-tracker.js:854
Onset strength (delegates to xa-onset).
Parameters
Section titled “Parameters”any[] | Float32Array<ArrayBufferLike>
number = 22050
hopLength?
Section titled “hopLength?”number = 512
Returns
Section titled “Returns”Float32Array<ArrayBufferLike>
setTempo()
Section titled “setTempo()”setTempo(
bpm):void
Defined in: packages/pleco-xa/src/scripts/xa-beat-tracker.js:815
Set a tempo hint (BPM) used by beatTrack() when no explicit bpm option is provided. Pass null to clear.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
tempoEstimation()
Section titled “tempoEstimation()”tempoEstimation(
onsetEnvelope,opts?):number
Defined in: packages/pleco-xa/src/scripts/xa-beat-tracker.js:843
Tempo estimation from a pre-computed onset envelope.
Parameters
Section titled “Parameters”onsetEnvelope
Section titled “onsetEnvelope”any[] | Float32Array<ArrayBufferLike>
any = {}
see tempo()
Returns
Section titled “Returns”number
BPM