Class BeatSync

Index

Constructors

Accessors

Methods

getBeatInterval getBeatProgress getBPM getTotalBeats getTotalMeasures onBeat onMeasure quantize reset setBPM start stop update

Constructors

constructor

new BeatSync(config: BeatSyncConfig): BeatSync
Parameters
- config: BeatSyncConfig
Returns BeatSync
- Defined in packages/clik-engine/src/audio/BeatSync.ts:36

Accessors

isActive

get isActive(): boolean
Returns boolean
- Defined in packages/clik-engine/src/audio/BeatSync.ts:125

Methods

getBeatInterval

getBeatInterval(): number
Get beat interval in ms

Returns number
- Defined in packages/clik-engine/src/audio/BeatSync.ts:111

getBeatProgress

getBeatProgress(): number
Get progress toward next beat (0-1)

Returns number
- Defined in packages/clik-engine/src/audio/BeatSync.ts:89

getBPM

getBPM(): number
Get current BPM

Returns number
- Defined in packages/clik-engine/src/audio/BeatSync.ts:106

getTotalBeats

getTotalBeats(): number
Get total beats counted

Returns number
- Defined in packages/clik-engine/src/audio/BeatSync.ts:116

getTotalMeasures

getTotalMeasures(): number
Get total measures counted

Returns number
- Defined in packages/clik-engine/src/audio/BeatSync.ts:121

onBeat

onBeat(callback: BeatCallback): this
Register a callback that fires on every beat
Parameters
- callback: BeatCallback
Returns this
- Defined in packages/clik-engine/src/audio/BeatSync.ts:77

onMeasure

onMeasure(callback: MeasureCallback): this
Register a callback that fires on every measure
Parameters
- callback: MeasureCallback
Returns this
- Defined in packages/clik-engine/src/audio/BeatSync.ts:83

quantize

quantize(timeMs: number): number
Quantize a time value to the nearest beat
Parameters
- timeMs: number
Returns number
- Defined in packages/clik-engine/src/audio/BeatSync.ts:94

reset

reset(): void
Reset counters

Returns void
- Defined in packages/clik-engine/src/audio/BeatSync.ts:130

setBPM

setBPM(bpm: number): this
Set new BPM
Parameters
- bpm: number
Returns this
- Defined in packages/clik-engine/src/audio/BeatSync.ts:99

start

start(): this
Start the beat clock

Returns this
- Defined in packages/clik-engine/src/audio/BeatSync.ts:43

stop

stop(): this
Stop the beat clock

Returns this
- Defined in packages/clik-engine/src/audio/BeatSync.ts:52

update

update(delta: number): void
Update the beat clock. Call each frame.
Parameters
- delta: number
Returns void
- Defined in packages/clik-engine/src/audio/BeatSync.ts:58