Class Decoder

Decoder class responsible for decoding video frames and rendering them using WebGL. Handles frame queueing, decoding, and rendering through WebGL.

Implements

IDecoder

Index

Constructors

Accessors

Methods

clear decode dispose enqueue start stop

Constructors

constructor

new Decoder(originalCanvas: HTMLCanvasElement, logger: ILogger): Decoder
Creates an instance of the Decoder class.
Parameters
- originalCanvas: HTMLCanvasElement
  The original HTML canvas element to render frames onto
- logger: ILogger
  Logger instance for debugging and error reporting
Returns Decoder
Throws
When video decoder configuration is not supported
- Defined in src/vim-web/core-viewers/ultra/decoder.ts:74

Accessors

paused

get paused(): boolean
Indicates whether the decoder is currently paused.

Returns boolean
True if paused, false otherwise.
Implementation of IDecoder.paused
- Defined in src/vim-web/core-viewers/ultra/decoder.ts:103

ready

get ready(): boolean
Indicates whether the decoder is ready and configured.

Returns boolean
True if the decoder is configured, false otherwise.
Implementation of IDecoder.ready
- Defined in src/vim-web/core-viewers/ultra/decoder.ts:64

Methods

clear

clear(): void
Clears the decoder state and renderer buffer. Does not close the decoder instance.

Returns void
- Defined in src/vim-web/core-viewers/ultra/decoder.ts:193

decode

decode(): void
Processes and decodes all queued video frame messages. Skips processing if the decoder isn't ready or the queue is empty.

Returns void
Throws
When decoding fails for a video chunk
- Defined in src/vim-web/core-viewers/ultra/decoder.ts:167

dispose

dispose(): void
Completely disposes of the decoder instance and releases all resources. Should be called when the decoder is no longer needed.

Returns void
- Defined in src/vim-web/core-viewers/ultra/decoder.ts:202

enqueue

enqueue(frame: VideoFrameMessage): void
Enqueues a video frame message for decoding. If a key frame is received, the queue is cleared except for the first frame to maintain decoder stability.
Parameters
- frame: VideoFrameMessage
  The video frame message to be queued for decoding
Returns void
- Defined in src/vim-web/core-viewers/ultra/decoder.ts:154

start

start(): void
Resumes the decoder and renderer.

Returns void
Implementation of IDecoder.start
- Defined in src/vim-web/core-viewers/ultra/decoder.ts:118

stop

stop(): void
Pauses the decoder and renderer.

Returns void
Implementation of IDecoder.stop
- Defined in src/vim-web/core-viewers/ultra/decoder.ts:110