Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShareProcessor Abstract

Base class for all source share stream processors.

Note: Available only in the share processor worker.

Hierarchy

  • ShareProcessor

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new ShareProcessor.

    Parameters

    • port: MessagePort

      port message port - The message port used for communication.

    • Optional options: any

      customised options - Optional processor configuration.

    Returns ShareProcessor

Properties

Protected port

port: MessagePort

The communication port used for messaging between the processor and the main thread.

Methods

getOutput

  • getOutput(): any

  • Retrieves the OffscreenCanvas that renders the current output frame or processed result.

    Returns any

onInit

  • onInit(): void

  • Called when the processor is initializated.

    Returns void

onUninit

  • onUninit(): void

  • Called when the processor is uninitialized.

    Returns void

Abstract processFrame

  • processFrame(input: VideoFrame, output: OffscreenCanvas): boolean | Promise<boolean>

  • Processes a share frame and optionally applies effects or transformations.

    Parameters

    • input: VideoFrame

      The input share frame to process.

    • output: OffscreenCanvas

      The canvas where the processed frame is rendered.

    Returns boolean | Promise<boolean>

    true/false or a Promise that resolves to a boolean indicating success or failure.