Class ApiDecoration

Namespace

VAST.Network

Assembly

VAST.Network.dll

Represents text decoration settings for overlays or captions in a media stream. Specifies font, size, style, and color properties for rendered text.

public class ApiDecoration

Inheritance

object

ApiDecoration

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ApiDecoration()

public ApiDecoration()

Properties

BackgroundColor

Gets or sets the background color as a hexadecimal ARGB color string. Default is "#00000000" (transparent black).

public string BackgroundColor { get; set; }

Property Value

string

Bold

Gets or sets a value indicating whether the text should be rendered in bold. Default is false.

public bool Bold { get; set; }

Property Value

bool

Color

Gets or sets the text color as a hexadecimal ARGB color string (e.g., "#FFFFFFFF" for white). Default is "#FFFFFFFF".

public string Color { get; set; }

Property Value

string

FontFamily

Gets or sets the font family name (e.g., "Arial", "Verdana"). Default is "Arial".

public string FontFamily { get; set; }

Property Value

string

Italic

Gets or sets a value indicating whether the text should be rendered in italic. Default is false.

public bool Italic { get; set; }

Property Value

bool

OutlineColor

Gets or sets the outline color as a hexadecimal ARGB color string. Default is "#FF000000" (black).

public string OutlineColor { get; set; }

Property Value

string

OutlineWidth

Gets or sets the outline width in pixels. Default is 0 (no outline).

public int OutlineWidth { get; set; }

Property Value

int

Size

Gets or sets the font size in points. Default is 10.

public float Size { get; set; }

Property Value

float