Class ApiSink

Namespace

VAST.Network

Assembly

VAST.Network.dll

Represents an output sink configuration for a publishing point in the REST API. A sink defines a destination URI and format for media output, with additional properties specific to ISO (MP4/fMP4) file sinks.

public class ApiSink

Inheritance

object

ApiSink

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ApiSink()

public ApiSink()

Properties

AutoCompleteState

Gets or sets a value indicating whether the recording state should be automatically completed. ISO sink specific.

public bool? AutoCompleteState { get; set; }

Property Value

bool?

AutoRestore

Gets or sets a value indicating whether the sink should be automatically restored after a failure or disconnection.

public bool? AutoRestore { get; set; }

Property Value

bool?

ExpectedDuration

Gets or sets the expected duration of the recording. ISO sink specific. Used to pre-allocate the file header for optimal MP4 file structure.

public string ExpectedDuration { get; set; }

Property Value

string

Format

Gets or sets the output container format for the sink (e.g. "mp4", "ts").

public string Format { get; set; }

Property Value

string

MinimalFreeDiskSpace

Gets or sets the minimal free disk space in bytes required to continue recording. ISO sink specific. Recording stops if available disk space falls below this threshold.

public long? MinimalFreeDiskSpace { get; set; }

Property Value

long?

Uri

Gets or sets the destination URI for the sink output (e.g. a file path or network address).

public string Uri { get; set; }

Property Value

string

WriteHeaderUpdateInterval

Gets or sets the interval in ticks at which the file header is updated during recording. ISO sink specific. Periodic header updates allow partial file recovery if the recording is interrupted.

public long? WriteHeaderUpdateInterval { get; set; }

Property Value

long?

WriteMediaDataLast

Gets or sets a value indicating whether media data should be written after the header. ISO sink specific. When true, the mdat box is placed after the moov box for progressive download compatibility.

public bool? WriteMediaDataLast { get; set; }

Property Value

bool?

WriteState

Gets or sets a value indicating whether recording state information should be written. ISO sink specific.

public bool? WriteState { get; set; }

Property Value

bool?