DWVv0.37.0

PixelBufferDecoder

Source: decoder.js:83

Pixel buffer decoder.


Constructor

new PixelBufferDecoder(algoName: string): PixelBufferDecoder

Parameters

  • algoName (string) — The compression algorithm name.

Instance Methods

decode(pixelBuffer: TypedArray, pixelMeta: object, info: object)

Decode a pixel buffer.

Parameters

  • pixelBuffer (TypedArray) — The pixel buffer.
  • pixelMeta (object) — The input meta data.
  • info (object) — Information object about the input data.

abort()

Abort decoding.

ondecodestart(_event: object)

Handle a decode start event. Default does nothing.

Parameters

  • _event (object) — The decode start event.

ondecodeditem(_event: object)

Handle a decode item event. Default does nothing.

Parameters

  • _event (object) — The decode item event fired when a decode item ended successfully.

ondecoded(_event: object)

Handle a decode event. Default does nothing.

Parameters

  • _event (object) — The decode event fired when a file has been decoded successfully.

ondecodeend(_event: object)

Handle a decode end event. Default does nothing.

Parameters

  • _event (object) — The decode end event fired when a file decoding has completed, successfully or not.

onerror(_event: object)

Handle an error event. Default does nothing.

Parameters

  • _event (object) — The error event.

onabort(_event: object)

Handle an abort event. Default does nothing.

Parameters

  • _event (object) — The abort event.