Class ScoreEncoder

constructor

• new ScoreEncoder(): ScoreEncoder

• Returns ScoreEncoder

Static DEFAULT_GAME_VERSION

encodeToBuffer

• encodeToBuffer(score?, beatmap?): Promise<Uint8Array>

• Performs score encoding to a buffer.

  Parameters

  • Optional score: IScore

    The score for encoding.
  • Optional beatmap: IBeatmap

    The beatmap of the replay. It is required if replay contains non-legacy frames.

  Returns Promise<Uint8Array>

  The buffer with encoded score & replay data.

  Throws

  If beatmap wasn't provided for non-legacy replay.

encodeToPath

• encodeToPath(path, score?, beatmap?): Promise<void>

• Performs score & replay encoding to the specified path.

  Parameters

  • path: string

    The path for writing the .osr file.
  • Optional score: IScore

    The score for encoding.
  • Optional beatmap: IBeatmap

    The beatmap of the replay. It is required if replay contains non-legacy frames.

  Returns Promise<void>

  Throws

  If score can't be encoded

  Throws

  If beatmap wasn't provided for non-legacy replay.

  Throws

  If score can't be encoded or file can't be written.