Class DefaultVideoFrameProcessorPipeline

constructor

• new DefaultVideoFrameProcessorPipeline(
      logger: Logger,
      stages: VideoFrameProcessor[],
      timer?: VideoFrameProcessorTimer,
      metricsCallback?: (
          metrics: {
              frameRate: number;
              processors: { averageProcessLatency: number; processorName: string }[];
          },
      ) => void,
  ): DefaultVideoFrameProcessorPipeline

  Parameters

  • logger: Logger
  • stages: VideoFrameProcessor[]
  • timer: VideoFrameProcessorTimer = ...
  • OptionalmetricsCallback: (
        metrics: {
            frameRate: number;
            processors: { averageProcessLatency: number; processorName: string }[];
        },
    ) => void

  Returns DefaultVideoFrameProcessorPipeline

outputMediaStream

framerate

• get framerate(): number

  The desired output frame rate.

  Returns number
• set framerate(value: number): void

  The desired output frame rate.

  Parameters

  • value: number

  Returns void

processors

• get processors(): VideoFrameProcessor[]

  Lists of processors to execute to produce output media stream.

  Returns VideoFrameProcessor[]
• set processors(stages: VideoFrameProcessor[]): void

  Lists of processors to execute to produce output media stream.

  Parameters

  • stages: VideoFrameProcessor[]

  Returns void

addObserver

• addObserver(observer: VideoFrameProcessorPipelineObserver): void

  Adds VideoFrameProcessorPipelineObserver observer to receive lifecycle and performance callback.

  Parameters

  • observer: VideoFrameProcessorPipelineObserver

  Returns void

destroy

• destroy(): void

  Destroys the pipeline, processors, intermediate buffers and input stream.

  Returns void

getActiveOutputMediaStream

• getActiveOutputMediaStream(): MediaStream

  Returns an active output stream.

  Returns MediaStream

getInputMediaStream

• getInputMediaStream(): Promise<MediaStream>

  Returns the current input MediaStream.

  Returns Promise<MediaStream>

process

• process(_event: Event): Promise<void>

  Parameters

  • _event: Event

  Returns Promise<void>

removeObserver

• removeObserver(observer: VideoFrameProcessorPipelineObserver): void

  Removes VideoFrameProcessorPipelineObserver observer.

  Parameters

  • observer: VideoFrameProcessorPipelineObserver

  Returns void

setInputMediaStream

• setInputMediaStream(inputMediaStream: MediaStream): Promise<void>

  inputMediaStream is by default used to construct one CanvasVideoFrameBuffer The buffer will be fed into the first VideoFrameProcessor.

  Parameters

  • inputMediaStream: MediaStream

  Returns Promise<void>

setMetricsCallback

• setMetricsCallback(
      callback: (
          metrics: {
              frameRate: number;
              processors: { averageProcessLatency: number; processorName: string }[];
          },
      ) => void,
  ): void

  Parameters

  • callback: (
        metrics: {
            frameRate: number;
            processors: { averageProcessLatency: number; processorName: string }[];
        },
    ) => void

  Returns void

stop

• stop(): void

  Stops the pipeline.

  Returns void