Class Player

Index

Constructors

Methods

destroy getScore on pause play seekTo setScore stop

Constructors

constructor

new Player(params?: Partial<PlayerParams>): Player
Creates a Player instance.
Parameters
- params: Partial<PlayerParams> = {}
  The accepted params
Returns Player
- Defined in packages/core/src/player.ts:66

Methods

destroy

destroy(): void
Returns void
- Defined in packages/core/src/player.ts:83

getScore

getScore(): Score | null
Returns Score | null
- Defined in packages/core/src/player.ts:89

on

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

pause

pause(): Player
Returns Player
- Defined in packages/core/src/player.ts:132

play

play(): Promise<Player | undefined>
Returns Promise<Player | undefined>
- Defined in packages/core/src/player.ts:122

seekTo

seekTo(position: `${number}:${number}:${number}`): void
Parameters
- position: `${number}:${number}:${number}`
Returns void
- Defined in packages/core/src/player.ts:142

setScore

setScore(score: Score | null): Player
Parameters
- score: Score | null
Returns Player
- Defined in packages/core/src/player.ts:96

stop

stop(): Player
Returns Player
- Defined in packages/core/src/player.ts:136