Class CustomVideoSampleGrabberEffect

Namespace

VisioForge.Core.Types.X.VideoEffects

Assembly

VisioForge.Core.dll

Custom video sample grabber effect that allows capturing video frames for processing.

public class CustomVideoSampleGrabberEffect : BaseVideoEffect, IBaseVideoEffect

Inheritance

object

BaseVideoEffect

CustomVideoSampleGrabberEffect

Implements

IBaseVideoEffect

Inherited Members

BaseVideoEffect.Name

BaseVideoEffect.ID

BaseVideoEffect.OnUpdate

BaseVideoEffect.OnUpdateCall()

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

CustomVideoSampleGrabberEffect(VideoFormatX, string)

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.CustomVideoSampleGrabberEffect class.

public CustomVideoSampleGrabberEffect(VideoFormatX format, string name = "custom-video-sg")

Parameters

format VideoFormatX

The video format for captured frames.

name string

The name of the effect.

Fields

DefaultName

The default name.

public static string DefaultName

Field Value

string

Properties

AllowFrameModification

Gets or sets whether an VisioForge.Core.Types.X.VideoEffects.CustomVideoSampleGrabberEffect.OnVideoFrameBuffer handler may modify the frame data in place. On a running pipeline a change applies when the effect is passed again to AddOrUpdateAsync (Video_Effects_AddOrUpdateAsync on VideoCaptureCoreX and MediaPlayerCoreX); until then no frames are delivered. When set, the frame is mapped for writing, so the changes go downstream and never into a frame another branch of the pipeline is reading. That costs a frame copy when the frame memory is shared or read-only.

public bool AllowFrameModification { get; set; }

Property Value

bool

Format

Gets or sets the format. On a running pipeline a change applies when the effect is passed again to AddOrUpdateAsync (Video_Effects_AddOrUpdateAsync on VideoCaptureCoreX and MediaPlayerCoreX); until then no frames are delivered.

public VideoFormatX Format { get; set; }

Property Value

VideoFormatX

OnVideoFrameBuffer

This event occurs whenever each new video frame is received.

public event EventHandler<VideoFrameXBufferEventArgs> OnVideoFrameBuffer

Event Type

EventHandler<VideoFrameXBufferEventArgs>