Class TextOverlayVideoEffect

Text overlay video effect.

Inheritance

object

BaseVideoEffect

TextOverlayVideoEffect

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 TextOverlayVideoEffect : BaseVideoEffect

Constructors

TextOverlayVideoEffect(string)

Initializes a new instance of the TextOverlayVideoEffect class.

Declaration

public TextOverlayVideoEffect(string name = "text_overlay")

Parameters

Type	Name	Description
string	name	The name.

Fields

DefaultName

The default name.

Declaration

public static string DefaultName

Field Value

Type	Description
string

Properties

AutoAjustSize

Gets or sets a value indicating whether automatically adjust font size to screen-size.

Declaration

public bool AutoAjustSize { get; set; }

Property Value

Type	Description
bool

Color

Gets or sets color to use for text (big-endian ARGB).

Declaration

public SKColor Color { get; set; }

Property Value

Type	Description
SKColor

DeltaX

Gets or sets shift X position to the left or to the right. Unit is pixels.

Declaration

public int DeltaX { get; set; }

Property Value

Type	Description
int

DeltaY

Gets or sets shift Y position up or down. Unit is pixels.

Declaration

public int DeltaY { get; set; }

Property Value

Type	Description
int

Font

Gets or sets font to be used for rendering.

Declaration

public FontSettings Font { get; set; }

Property Value

Type	Description
FontSettings

HorizontalAlignment

Gets or sets horizontal alignment of the text.

Declaration

public TextOverlayHAlign HorizontalAlignment { get; set; }

Property Value

Type	Description
TextOverlayHAlign

LineAignment

Gets or sets alignment of text lines relative to each other (for multi-line text).

Declaration

public TextOverlayLineAlign LineAignment { get; set; }

Property Value

Type	Description
TextOverlayLineAlign

Mode

Gets or sets mode.

Declaration

public TextOverlayMode Mode { get; set; }

Property Value

Type	Description
TextOverlayMode

OutlineColor

Gets or sets color to use for outline the text (big-endian ARGB).

Declaration

public SKColor OutlineColor { get; set; }

Property Value

Type	Description
SKColor

Shading

Gets or sets a value indicating whether to shade the background under the text area.

Declaration

public bool Shading { get; set; }

Property Value

Type	Description
bool

Text

Gets or sets text to display.

Declaration

public string Text { get; set; }

Property Value

Type	Description
string

TimeFormat

Gets or sets the time format. Default value is "%H:%M:%S". Used if Mode set to SystemTime.

Declaration

public string TimeFormat { get; set; }

Property Value

Type	Description
string

TurnOff

Gets or sets a value indicating whether text rendering disabled.

Declaration

public bool TurnOff { get; set; }

Property Value

Type	Description
bool

VerticalAlignment

Gets or sets vertical alignment of the text.

Declaration

public TextOverlayVAlign VerticalAlignment { get; set; }

Property Value

Type	Description
TextOverlayVAlign

VerticalRender

Gets or sets a value indicating whether vertical render enabled.

Declaration

public bool VerticalRender { get; set; }

Property Value

Type	Description
bool

WrapMode

Gets or sets whether to wrap the text and if so how.

Declaration

public TextOverlayWrapMode WrapMode { get; set; }

Property Value

Type	Description
TextOverlayWrapMode

XPad

Gets or sets horizontal paddding when using left/right alignment.

Declaration

public int XPad { get; set; }

Property Value

Type	Description
int

XPos

Gets or sets horizontal position when using position alignment.

Declaration

public double XPos { get; set; }

Property Value

Type	Description
double

YPad

Gets or sets vertical padding when using top/bottom alignment.

Declaration

public int YPad { get; set; }

Property Value

Type	Description
int

YPos

Gets or sets vertical position when using position alignment.

Declaration

public double YPos { get; set; }

Property Value

Type	Description
double

Methods

ToSettings()

Converts to settings.

Declaration

public TextOverlaySettings ToSettings()

Returns

Type	Description
TextOverlaySettings	TextOverlaySettings.