Class ApiLayer

Namespace

VAST.Network

Assembly

VAST.Network.dll

Represents a video mixing layer in the API request model. A layer defines how one or more sources are composited, including layout, stretch mode, position, crop region, rotation, opacity, and visual effects such as blur and chroma key.

public class ApiLayer

Inheritance

object

ApiLayer

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ApiLayer()

public ApiLayer()

Properties

BlurSize

Gets or sets blur to apply to source images. If value is 0 then blur is disabled.

public int? BlurSize { get; set; }

Property Value

int?

BrightnessAdjustment

Gets or sets brightness adjustment to apply to source images. Accepted values are in -10..10 range. If value is 0 then brightness adjustment is disabled.

public float? BrightnessAdjustment { get; set; }

Property Value

float?

ChromaKeyColor

Gets or sets color to be used to apply chroma key to source. The format is a hex string. Accepted formats: #ARGB, #RGB, ARGB, RGB. Examples: #FFFFFFFF, #FFFF00, FFFF0000, FF0000. Default value is null, i.e. chroma key is disabled.

public string ChromaKeyColor { get; set; }

Property Value

string

ChromaKeySmoothing

Gets or sets chroma key smoothing. The recommended value range is 0.0..0.1 but it depends on particular setup. Makes sense only if chroma key is enabled. When not specified the default value is 0.05.

public float? ChromaKeySmoothing { get; set; }

Property Value

float?

ChromaKeyThreshold

Gets or sets chroma key threshold. The recommended value range is 0.02..0.12 but it depends on particular setup. Makes sense only if chroma key is enabled. When not specified the default value is 0.1.

public float? ChromaKeyThreshold { get; set; }

Property Value

float?

ContrastAdjustment

Gets or sets contrast adjustment to apply to source images Accepted values are in -10..10 range. If value is 0 then contrast adjustment is disabled.

public float? ContrastAdjustment { get; set; }

Property Value

float?

Crop

Gets or sets the crop region applied to the source before compositing. Coordinates are specified as left, top, right, and bottom pixel values.

public Rect Crop { get; set; }

Property Value

Rect

FadeInMsec

Gets or sets the fade-in duration in milliseconds applied when this layer becomes visible.

public int? FadeInMsec { get; set; }

Property Value

int?

FadeOutMsec

Gets or sets the fade-out duration in milliseconds applied when this layer is hidden.

public int? FadeOutMsec { get; set; }

Property Value

int?

FillColor

Gets or sets the fill color for empty areas of this layer as a hex string (e.g. "#FF000000").

public string FillColor { get; set; }

Property Value

string

Layout

Gets or sets the layout type that determines how sources are arranged on this layer. Defaults to Manual when not specified.

public LayoutType Layout { get; set; }

Property Value

LayoutType

Location

Gets or sets the position and size of this layer as a rectangle within the output frame. Coordinates are specified as left, top, right, and bottom pixel values.

public Rect Location { get; set; }

Property Value

Rect

Opacity

Gets or sets the opacity of this layer. A value of 1.0 means fully opaque, 0.0 means fully transparent.

public float? Opacity { get; set; }

Property Value

float?

Rotation

Gets or sets the rotation angle in degrees to apply to this layer.

public int? Rotation { get; set; }

Property Value

int?

Sources

Gets or sets list of source indices which should be shown on this layer. At least one source must be specified. If layout type is manual then only one source must be specified.

public List<int> Sources { get; set; }

Property Value

List<int>

Stretch

Gets or sets the stretch type that determines how source content is scaled to fit the layer area. Defaults to Original when not specified.

public StretchType Stretch { get; set; }

Property Value

StretchType