Class Player

Index

Constructors

Methods

destroy getBpm getScore on pause play seekTo setBpm setScore stop

Constructors

constructor

new Player(__namedParameters: PlayerParams): Player
Creates a Player instance.
Parameters
- __namedParameters: PlayerParams
  The accepted params
Returns Player
- Defined in packages/core/src/player.ts:174

Methods

destroy

destroy(): void
Clears all event listeners and future playback scheduled events.

Returns void
- Defined in packages/core/src/player.ts:203

getBpm

getBpm(): number
Returns the current transport bpm value.

Returns number
The bpm value.
- Defined in packages/core/src/player.ts:260

getScore

getScore(): Score | null
Returns the current score.

Returns Score | null
The current score.
- Defined in packages/core/src/player.ts:213

on

on(
eventName: PlayerEvents,
callback: PlayerCallback,
): () => EventEmitter<DefaultEventMap>
Parameters
- eventName: PlayerEvents
- callback: PlayerCallback
Returns () => EventEmitter<DefaultEventMap>
- Defined in packages/core/src/player.ts:216

pause

pause(): Player
Pauses playback.

Returns Player
The current Player instance.
- Defined in packages/core/src/player.ts:281

play

play(): Promise<Player | undefined>
Starts playback.

Returns Promise<Player | undefined>
The current Player instance.
- Defined in packages/core/src/player.ts:267

seekTo

seekTo(position: `${number}:${number}:${number}`): Player
Seeks playback to the passed position.
Parameters
- position: `${number}:${number}:${number}`
  The new position.
Returns Player
The current Player instance.
- Defined in packages/core/src/player.ts:300

setBpm

setBpm(value: number): void
Sets the current transport bpm value.
Parameters
- value: number
  The new bpm value.
Returns void

Throws
Value must be in the ${BPM_RANGE} range, received ${value} instead if the passed value is not the BPM range.
- Defined in packages/core/src/player.ts:248

setScore

setScore(score: Score | null): Player
Sets the current score.
Parameters
- score: Score | null
  The score to be set.
Returns Player
The current Player instance.
- Defined in packages/core/src/player.ts:225

stop

stop(): Player
Stops playback.

Returns Player
The current Player instance.
- Defined in packages/core/src/player.ts:289