Class ApiPublishingPointRequest

Namespace

VAST.Network

Assembly

VAST.Network.dll

Represents a request model for creating or updating a publishing point via the REST API. Extends ApiGeneralRequest with publishing point-specific fields such as path, sources, sinks, processing configuration, streaming mode, and various timeout settings.

public class ApiPublishingPointRequest : ApiGeneralRequest

Inheritance

object

ApiGeneralRequest

ApiPublishingPointRequest

Inherited Members

ApiGeneralRequest.Token

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ApiPublishingPointRequest()

public ApiPublishingPointRequest()

Properties

AllowAbsoluteTimestamps

Gets or sets a value indicating whether the source is allowed to use absolute timestamps instead of relative timestamps starting from zero.

public bool? AllowAbsoluteTimestamps { get; set; }

Property Value

bool?

AllowVideoProcessing

Gets or sets a value indicating whether video processing (e.g. mixing, compositing) is enabled for this publishing point.

public bool? AllowVideoProcessing { get; set; }

Property Value

bool?

AllowedProtocols

Gets or sets the streaming protocols allowed for this publishing point (e.g. HLS, DASH).

public StreamingProtocol AllowedProtocols { get; set; }

Property Value

StreamingProtocol

EnableSmoothOutputBuffer

Gets or sets a value indicating whether smooth output buffering is enabled. When enabled, the output buffer smooths out jitter in the media stream delivery.

public bool? EnableSmoothOutputBuffer { get; set; }

Property Value

bool?

ExpirationTimeoutSec

Gets or sets the expiration timeout in seconds after which the publishing point is automatically removed.

public int? ExpirationTimeoutSec { get; set; }

Property Value

int?

FallbackSwitchTimeoutMs

Gets or sets timeout after which output switches to a fallback source if one is specified. By default this timeout is 0, i.e. output switches to a fallback source as soon as a main source is down. It can be set to a non-zero value to prevent switching to a fallback source in case of a short main source disconnection.

public int? FallbackSwitchTimeoutMs { get; set; }

Property Value

int?

ForceVideoResampling

Gets or sets whether source video streams should be forcibly downsized to resolution in the output video before ingesting into an image processor. Normally it's decided by the MixingSource but if a scene contains many sources then the flag should be set to true to maximize the performance. The default value is false, i.e. it's the MixingSource decision.

public bool? ForceVideoResampling { get; set; }

Property Value

bool?

InactivityTimeoutSec

Gets or sets the inactivity timeout in seconds after which the publishing point is automatically removed if no clients are connected.

public int? InactivityTimeoutSec { get; set; }

Property Value

int?

Item

Gets or sets the item identifier extracted from the request URL path. Not serialized to JSON.

public string Item { get; set; }

Property Value

string

Loop

Gets or sets a value indicating whether the source playlist should loop continuously.

public bool? Loop { get; set; }

Property Value

bool?

NoSamplesTimeoutMs

Gets or sets the timeout in milliseconds after which the publishing point is stopped if no media samples are received from the source.

public int? NoSamplesTimeoutMs { get; set; }

Property Value

int?

Path

Gets or sets the URL path at which the publishing point is accessible.

public string Path { get; set; }

Property Value

string

Processing

Gets or sets the audio and video processing configuration for this publishing point.

public ApiProcessing Processing { get; set; }

Property Value

ApiProcessing

Sinks

Gets or sets the list of output sinks attached to this publishing point.

public List<ApiSink> Sinks { get; set; }

Property Value

List<ApiSink>

Sources

Gets or sets the list of media sources for this publishing point.

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

Property Value

List<ApiSource>

StreamingMode

Gets or sets the streaming mode for the publishing point (e.g. live or on-demand). Defaults to Live when not specified.

public StreamingMode StreamingMode { get; set; }

Property Value

StreamingMode

Title

Gets or sets the human-readable title of the publishing point.

public string Title { get; set; }

Property Value

string

UserData

Gets or sets arbitrary user-defined data associated with the publishing point.

public string UserData { get; set; }

Property Value

string