Class BoxVideoEffect

Box video effect.

Inheritance

object

BaseVideoEffect

BoxVideoEffect

Implements

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

Namespace: VisioForge.Core.Types.X.VideoEffects

Assembly: VisioForge.Core.dll

Syntax

public class BoxVideoEffect : BaseVideoEffect, IVideoEditXVideoEffect

Constructors

BoxVideoEffect(int, int, int, int)

Initializes a new instance of the BoxVideoEffect class.

Declaration

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

Parameters

Type	Name	Description
int	left	The left.
int	top	The top.
int	right	The right.
int	bottom	The bottom.

Fields

DefaultName

The default name.

Declaration

public static string DefaultName

Field Value

Type	Description
string

Properties

Alpha

Gets or sets the alpha.

Declaration

public double Alpha { get; set; }

Property Value

Type	Description
double	The alpha.

AutoCrop

Gets or sets a value indicating whether videobox will automatically crop/pad the input video to be centered in the output.

Declaration

public bool AutoCrop { get; set; }

Property Value

Type	Description
bool	true if automatic crop is enabled; otherwise, false.

BorderAlpha

Gets or sets the border alpha.

Declaration

public double BorderAlpha { get; set; }

Property Value

Type	Description
double	The border alpha.

Bottom

Gets the pixels to crop at bottom. Positive values will crop, negative values will pad.

Declaration

public int Bottom { get; }

Property Value

Type	Description
int

Fill

Gets or sets the fill.

Declaration

public VideoBoxFill Fill { get; set; }

Property Value

Type	Description
VideoBoxFill	The fill.

Left

Gets the pixels to crop at left. Positive values will crop, negative values will pad.

Declaration

public int Left { get; }

Property Value

Type	Description
int

Right

Gets the pixels to crop at right. Positive values will crop, negative values will pad.

Declaration

public int Right { get; }

Property Value

Type	Description
int

StartTime

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

Declaration

public TimeSpan StartTime { get; set; }

Property Value

Type	Description
TimeSpan

StopTime

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

Declaration

public TimeSpan StopTime { get; set; }

Property Value

Type	Description
TimeSpan

Top

Gets the pixels to crop at top. Positive values will crop, negative values will pad.

Declaration

public int Top { get; }

Property Value

Type	Description
int

Methods

GenerateDescription()

Generates the description.

Declaration

public string GenerateDescription()

Returns

Type	Description
string	System.String.

Exceptions

Type	Condition
NotImplementedException

Implements

IVideoEditXVideoEffect