Class OverlayText

Namespace

VAST.Media

Assembly

VAST.Common.dll

Represents an overlay text descriptor used in video processing.

public class OverlayText : INotifyPropertyChanged

Inheritance

object

OverlayText

Implements

INotifyPropertyChanged

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

OverlayText()

public OverlayText()

Properties

BackgroundColor

Gets or sets the background color as a hexadecimal string.

public string BackgroundColor { get; set; }

Property Value

string

Remarks

Accepted formats: #AARRGGBB, #RRGGBB, AARRGGBB, RRGGBB. Examples: #FFFFFFFF, #FFFF00, FFFF0000, FF0000.

FontBold

Gets or sets a value indicating whether the font is bold.

public bool FontBold { get; set; }

Property Value

bool

FontColor

Gets or sets the font color as a hexadecimal string.

public string FontColor { get; set; }

Property Value

string

Remarks

Accepted formats: #AARRGGBB, #RRGGBB, AARRGGBB, RRGGBB. Examples: #FFFFFFFF, #FFFF00, FFFF0000, FF0000.

FontFamily

Gets or sets the font family name.

public string FontFamily { get; set; }

Property Value

string

FontItalic

Gets or sets a value indicating whether the font is italic.

public bool FontItalic { get; set; }

Property Value

bool

FontSize

Gets or sets the font size in points.

public float FontSize { get; set; }

Property Value

float

HorizontalAlignment

Gets or sets the horizontal alignment of the text on the output video.

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

HorizontalAlignment

Location

Gets or sets the text location on the output video.

public Rect Location { get; set; }

Property Value

Rect

OutlineColor

Gets or sets the outline color as a hexadecimal string.

public string OutlineColor { get; set; }

Property Value

string

Remarks

Accepted formats: #AARRGGBB, #RRGGBB, AARRGGBB, RRGGBB. Examples: #FFFFFFFF, #FFFF00, FFFF0000, FF0000.

OutlineWidth

Gets or sets the outline width.

public float OutlineWidth { get; set; }

Property Value

float

Remarks

A value of 0 means no outline is drawn.

Text

Gets or sets the text to overlay.

public string Text { get; set; }

Property Value

string

VerticalAlignment

Gets or sets the vertical alignment of the text on the output video.

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

VerticalAlignment

Methods

Equals(object)

Determines whether the specified object is equal to the current instance.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if the specified object is equal to the current instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

A hash code for this instance.

Events

PropertyChanged

Occurs when a property value changes.

public event PropertyChangedEventHandler PropertyChanged

Event Type

PropertyChangedEventHandler

Operators

operator ==(OverlayText, OverlayText)

Determines whether two OverlayText instances are equal.

public static bool operator ==(OverlayText left, OverlayText right)

Parameters

left OverlayText

The first instance to compare.

right OverlayText

The second instance to compare.

Returns

bool

true if the instances are equal; otherwise, false.

operator !=(OverlayText, OverlayText)

Determines whether two OverlayText instances are not equal.

public static bool operator !=(OverlayText left, OverlayText right)

Parameters

left OverlayText

The first instance to compare.

right OverlayText

The second instance to compare.

Returns

bool

true if the instances are not equal; otherwise, false.