Skip to main content

Interface: DecodedFrameConsumer

Defined in: livelink.js/sources/rendering/streaming/DecodedFrameConsumer.ts:27

The interface for consuming decoded frames.

To consume decoded frames, implement this interface and pass an instance of your class to the encoded_frame_consumer when calling Livelink.setEncodedFrameConsumer.

The EncodedFrameConsumer will call the consumeDecodedFrame method as soon as a frame is decoded.

An internal default implementation of this interface can be retrieved via the Livelink.default_decoded_frame_consumer property.

It is recommended to use the default implementation.

Methods​

consumeDecodedFrame()​

consumeDecodedFrame(params: {
  decoded_frame: OffscreenCanvas | VideoFrame;
  meta_data: FrameMetaData;
 }): void

Defined in: livelink.js/sources/rendering/streaming/DecodedFrameConsumer.ts:37

Consume a decoded frame.

This method is called as soon as a frame is decoded.

Parameters​

ParameterTypeDescription
params{ decoded_frame: OffscreenCanvas | VideoFrame; meta_data: FrameMetaData; }
params.decoded_frameOffscreenCanvas | VideoFrameThe decoded frame data
params.meta_dataFrameMetaDataThe frame meta data

Returns​

void