Class ScoreDecoder

A score decoder.

Hierarchy

Decoder
- ScoreDecoder

Index

Constructors

Methods

decodeFromBuffer decodeFromPath

Constructors

constructor

new ScoreDecoder(): ScoreDecoder
Returns ScoreDecoder
Inherited from Decoder.constructor

Methods

decodeFromBuffer

decodeFromBuffer(buffer, parseReplay?): Promise<Score>
Performs score decoding from a buffer.
Parameters
- buffer: BufferLike
  The buffer with score data.
- parseReplay: boolean = true
  Should replay be parsed?
Returns Promise<Score>
A decoded score.
- Defined in Decoders/ScoreDecoder.ts:51

decodeFromPath

decodeFromPath(path, parseReplay?): Promise<Score>
Performs score decoding from the specified .osr file.
Parameters
- path: string
  A path to the .osr file.
- parseReplay: boolean = true
  Should replay be parsed?
Returns Promise<Score>
A decoded score.

Throws
If file doesn't exist or can't be decoded.
- Defined in Decoders/ScoreDecoder.ts:28