Class JpegStreamReader

A JPEG stream reader

Index

Constructors

Methods

getImageData getResult parse requestMemoryAllocation resetFrames resetMaxMemoryUsage

Constructors

constructor

new JpegStreamReader(opts?: JPEGOptions): JpegStreamReader
Parameters
- Optionalopts: JPEGOptions
  The user provided options
Returns JpegStreamReader

Methods

getImageData

getImageData(): Image
Get the complete image data

Returns Image
- The image data

getResult

getResult(): ParseResult
Get a result of the frame decoding

Returns ParseResult
- The result of the frame decoding

parse

parse(data: Uint8Array): void
Parse the data into the frames
Parameters
- data: Uint8Array
  The individual block of JPEG data to parse
Returns void

requestMemoryAllocation

requestMemoryAllocation(increaseAmount?: number): void
Increase the max memory usage
Parameters
- increaseAmount: number = 0
  The amount to increase the max memory usage
Returns void

resetFrames

resetFrames(): void
Reset the frames

Returns void

resetMaxMemoryUsage

resetMaxMemoryUsage(maxMemoryUsageBytes: number): void
Reset the max memory usage
Parameters
- maxMemoryUsageBytes: number
  The new max memory usage
Returns void