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
- Optionalparams: Partial<PlayerParams>
  The accepted params
Returns Player
- Defined in packages/core/dist/index.d.ts:79

Methods

destroy

destroy(): void
Returns void
- Defined in packages/core/dist/index.d.ts:80

getScore

getScore(): Score | null
Returns Score | null
- Defined in packages/core/dist/index.d.ts:81

on

on(
eventName: PlayerEvents,
callback: PlayerCallback,
): () => EventEmitter<[never]>
Parameters
- eventName: PlayerEvents
- callback: PlayerCallback
Returns () => EventEmitter<[never]>
- Defined in packages/core/dist/index.d.ts:82

pause

pause(): this
Returns this
- Defined in packages/core/dist/index.d.ts:85

play

play(): Promise<Player | undefined>
Returns Promise<Player | undefined>
- Defined in packages/core/dist/index.d.ts:84

seekTo

seekTo(position: `${number}:${number}:${number}`): void
Parameters
- position: `${number}:${number}:${number}`
Returns void
- Defined in packages/core/dist/index.d.ts:87

setScore

setScore(score: Score | null): this
Parameters
- score: Score | null
Returns this
- Defined in packages/core/dist/index.d.ts:83

stop

stop(): this
Returns this
- Defined in packages/core/dist/index.d.ts:86