Class CropVideoEffect

Namespace

VisioForge.Core.Types.X.VideoEffects

Assembly

VisioForge.Core.dll

Represents a video crop effect that removes pixels from the edges of video frames.

public class CropVideoEffect : BaseVideoEffect, IBaseVideoEffect, IVideoEditXVideoEffect

Inheritance

object

BaseVideoEffect

CropVideoEffect

Implements

IBaseVideoEffect

IVideoEditXVideoEffect

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()

Remarks

SDK Availability: VideoCaptureCoreX, MediaPlayerCoreX, VideoEditCoreX, Media Blocks SDK

Platform Support: Windows, Linux, macOS, Android, iOS

The crop effect removes specified numbers of pixels from each edge of the video frame, effectively reducing the frame dimensions. This is useful for removing unwanted borders, changing aspect ratios, or focusing on a specific region of interest.

Key Features:

• Edge-Based Cropping: Specify pixels to remove from each edge independently
• Zero-Copy Operation: Efficient implementation without frame buffer copying
• Time Control: Optional start/stop time for VideoEditCoreX
• Rectangle Constructor: Convenient initialization from Rect object

Common Use Cases:

• Removing black bars (letterboxing/pillarboxing)
• Converting aspect ratios (16:9 to 4:3, etc.)
• Removing camera artifacts or unwanted edges
• Extracting regions of interest
• Preparing video for specific display formats

For Classic SDK, crop functionality is available through VideoEffectPan (Windows only).

Performance Note: Cropping is a very efficient operation as it manipulates frame metadata rather than pixel data. Has minimal CPU impact and can be combined with other effects.

Constructors

CropVideoEffect(int, int, int, int)

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

public CropVideoEffect(int left, int top, int right, int bottom)

Parameters

left int

The number of pixels to crop from the left edge.

top int

The number of pixels to crop from the top edge.

right int

The number of pixels to crop from the right edge.

bottom int

The number of pixels to crop from the bottom edge.

CropVideoEffect(Rect)

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

public CropVideoEffect(Rect rect)

Parameters

rect Rect

The rectangle defining the crop boundaries.

Fields

DefaultName

The default name.

public static string DefaultName

Field Value

string

Properties

Bottom

Gets the pixels to crop at bottom.

public int Bottom { get; }

Property Value

int

Left

Gets the pixels to crop at left.

public int Left { get; }

Property Value

int

Right

Gets the pixels to crop at right.

public int Right { get; }

Property Value

int

StartTime

Gets or sets the start time. Used only in VideoEditCoreX.

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

StopTime

Gets or sets the stop time. Used only in VideoEditCoreX.

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

Top

Gets the pixels to crop at top.

public int Top { get; }

Property Value

int

Methods

GenerateDescription()

Generates the description.

public string GenerateDescription()

Returns

string

A string containing the GStreamer element description for the videocrop effect.