Class Source

Namespace

VAST.Image.Mixing

Assembly

VAST.Image.dll

Defines an input source for the mixing scene, which can be a URI, media source object, or content object (text, image data). Supports playback options like looping and intervals.

public class Source

Inheritance

object

Source

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Source()

public Source()

Properties

Content

Gets or sets the content object (text string, image data, etc.) for dynamic sources. This property is not serialized to JSON.

[JsonIgnore]
public object Content { get; set; }

Property Value

object

Decoration

Gets or sets the text decoration settings for text content sources.

public Decoration Decoration { get; set; }

Property Value

Decoration

Format

Gets or sets the content format hint (e.g., "text", "image") for interpreting the Content property.

public string Format { get; set; }

Property Value

string

Height

Gets or sets the optional height override for the source content.

public int? Height { get; set; }

Property Value

int?

HorizontalAlignment

Gets or sets the horizontal alignment of the source content within its layer.

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

HorizontalAlignment

IntervalFrom

Gets or sets the start time offset for playback within the source media.

public TimeSpan? IntervalFrom { get; set; }

Property Value

TimeSpan?

IntervalTo

Gets or sets the end time offset for playback within the source media.

public TimeSpan? IntervalTo { get; set; }

Property Value

TimeSpan?

KeepLastRenderedFrame

Gets or sets whether the last rendered frame of the source should be kept in the scene indefinitely even if the source disconnects. The default value is false, i.e. the source is removed from the scene as soon as its disconnection detected. Only makes sense if Descriptor.AllowVideoProcessing is true, otherwise ignored.

public bool? KeepLastRenderedFrame { get; set; }

Property Value

bool?

Loop

Gets or sets whether this source should loop playback. Overrides the global Loop setting.

public bool? Loop { get; set; }

Property Value

bool?

MediaSource

Gets or sets the media source object directly. Takes precedence over Uri if specified. This property is not serialized to JSON.

[JsonIgnore]
public IMediaSource MediaSource { get; set; }

Property Value

IMediaSource

NoInputTimeoutSec

Gets or sets the timeout in seconds after which the source is considered disconnected if no input is received.

public int NoInputTimeoutSec { get; set; }

Property Value

int

Uri

Gets or sets the URI of the media source (file path, URL, or stream URI).

public string Uri { get; set; }

Property Value

string

VerticalAlignment

Gets or sets the vertical alignment of the source content within its layer.

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

VerticalAlignment

Width

Gets or sets the optional width override for the source content.

public int? Width { get; set; }

Property Value

int?