Class ApiSource

Namespace

VAST.Network

Assembly

VAST.Network.dll

Represents a media source configuration for the JSON API. Contains settings for source URI, format, content type, dimensions, alignment, and playback control.

public class ApiSource

Inheritance

object

ApiSource

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ApiSource()

public ApiSource()

Properties

Content

Gets or sets the content type of the source (e.g., "audio", "video").

public string Content { get; set; }

Property Value

string

Decoration

Gets or sets the decoration settings for the source.

public ApiDecoration Decoration { get; set; }

Property Value

ApiDecoration

DeleteFileOnClose

Gets or sets whether the source file should be deleted when the source is closed.

public bool? DeleteFileOnClose { get; set; }

Property Value

bool?

Format

Gets or sets the format of the source media (e.g., "RTMP", "HTTP").

public string Format { get; set; }

Property Value

string

Height

Gets or sets the height of the source in pixels.

public int? Height { get; set; }

Property Value

int?

HorizontalAlignment

Gets or sets the horizontal alignment of the source within the output frame.

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

HorizontalAlignment

IntervalFrom

Gets or sets the start time interval for the source playback.

public TimeSpan? IntervalFrom { get; set; }

Property Value

TimeSpan?

IntervalTo

Gets or sets the end time interval for the source playback.

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 the source should loop when playback reaches the end.

public bool? Loop { get; set; }

Property Value

bool?

MediaSource

Gets or sets the underlying media source object.

public IMediaSource MediaSource { get; set; }

Property Value

IMediaSource

NoInputTimeoutSec

Gets or sets the timeout duration in seconds for detecting no input from the source.

public int? NoInputTimeoutSec { get; set; }

Property Value

int?

Title

Gets or sets the display title of the source.

public string Title { get; set; }

Property Value

string

Uri

Gets or sets the URI of the media source.

public string Uri { get; set; }

Property Value

string

VerticalAlignment

Gets or sets the vertical alignment of the source within the output frame.

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

VerticalAlignment

Width

Gets or sets the width of the source in pixels.

public int? Width { get; set; }

Property Value

int?