Interface IApiControllableSource

Namespace

VAST.Network

Assembly

VAST.Network.dll

Interface for sources that can be controlled and configured via the JSON API. Provides access to the current descriptor and methods to update source configuration.

public interface IApiControllableSource

Properties

Descriptor

Gets the current publishing point request descriptor containing the source configuration.

ApiPublishingPointRequest Descriptor { get; }

Property Value

ApiPublishingPointRequest

Methods

Update(ApiPublishingPointRequest)

Updates the source configuration with new settings from the provided request.

ApiControllableSourceResult Update(ApiPublishingPointRequest request)

Parameters

request ApiPublishingPointRequest

The new publishing point request containing updated configuration parameters.

Returns

ApiControllableSourceResult

The result of the update operation indicating success or failure with any relevant details.