Class FrameProcessor<TFrame>

Namespace

LiveKit.Rtc

Assembly

LivekitRtc.dll

Abstract base class for processing audio or video frames.

public abstract class FrameProcessor<TFrame> where TFrame : class

Type Parameters

TFrame

The type of frame to process (AudioFrame or VideoFrame).

Inheritance

object

FrameProcessor<TFrame>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

IsEnabled

Gets whether the frame processor is enabled.

public abstract bool IsEnabled { get; set; }

Property Value

bool

Methods

Close()

Close and clean up the frame processor.

public abstract void Close()

OnCredentialsUpdated(FrameProcessorCredentials)

Hook for the server URL and access token of the room, for processors that call LiveKit services. This version of the SDK never calls it.

public virtual void OnCredentialsUpdated(FrameProcessorCredentials credentials)

Parameters

credentials FrameProcessorCredentials

The updated credentials.

OnStreamInfoUpdated(FrameProcessorStreamInfo)

Hook for the room, participant and publication of the processed stream. This version of the SDK never calls it.

public virtual void OnStreamInfoUpdated(FrameProcessorStreamInfo info)

Parameters

info FrameProcessorStreamInfo

The updated stream information.

Process(TFrame)

Process a frame and return the processed frame.

public abstract TFrame Process(TFrame frame)

Parameters

frame TFrame

The frame to process.

Returns

TFrame

The processed frame.