Table of Contents

Namespace VAST.Network

Classes

AggregatedNetworkSource

Represents a network source that aggregates multiple media sources into a single virtual source.

ApiAudioMixing

Represents audio mixing configuration for media stream processing. Specifies mixing type and parameters for combining multiple audio sources.

ApiAudioProcessing

Represents audio processing configuration for a media stream. Specifies whether to discard or transcode audio and defines mixing and track settings.

ApiAudioTrack

Represents audio track configuration for a media stream. Specifies audio parameters such as sample rate, channels, codec, and optional mixing settings.

ApiControllableSourceResult

Represents the result of a controllable source operation. Contains response information including status code, result message, server redirection, and token generation.

ApiDecoration

Represents text decoration settings for overlays or captions in a media stream. Specifies font, size, style, and color properties for rendered text.

ApiFilter

Represents an audio filter that applies mixing and fade parameters to specified sources. Defines which sources should be processed and what transformations to apply.

ApiGeneralRequest

Represents a general API request base class with authentication token support. Used as a foundation for API requests that require authentication.

ApiLayer

Represents a video mixing layer in the API request model. A layer defines how one or more sources are composited, including layout, stretch mode, position, crop region, rotation, opacity, and visual effects such as blur and chroma key.

ApiProcessing

Represents audio and video processing configuration for a publishing point. Contains optional ApiVideoProcessing and ApiAudioProcessing settings that control transcoding and media processing behavior.

ApiPublishingPointRequest

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.

ApiServerParameters

Contains configuration parameters for the VAST.Network.ApiServer. Defines authentication settings including user credentials, shared secret key, and token expiration.

ApiSink

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.

ApiSource

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

ApiUnknowCommand

Represents an unrecognized API command received by the server. Serves as a fallback handler for unknown commands that can be processed by custom handlers.

ApiVideoMixing

Represents video mixing settings for combining multiple sources into a single output. Supports different mixing types such as single source or all sources display modes.

ApiVideoProcessing

Represents video processing configuration including transcoding, mixing, and per-track settings.

ApiVideoTrack

Represents configuration settings for a single video track including codec, dimensions, framerate, and bitrate.

ClientTypeHelper

Provides helper methods for working with client types.

ConnectedClient

Represents a connected client session associated with a VAST.Network.ConnectedClient.PublishingPoint.

ConnectionInfo

Represents metadata and authorization information for a network connection to the streaming server.

CreatedPublishingPointParameters

Contains output parameters returned after a publishing point has been created, such as the actual publishing path and additional URI parameters.

MessageEventArgs

Provides data for the NewMessage event.

MixingSource

Represents a network-aware media mixing source that composites multiple input sources (video overlay, audio mixing) into a single output. Extends the base MixingSource with streaming server integration and API controllability.

NetworkGlobal

Provides global network configuration settings and utility methods.

NetworkStat

Represents network session statistics including transfer rates, latency, and error counts.

PublishingPoint

Represents a single publishing point on the streaming server that manages a media source and its associated client sinks. A publishing point routes media data from a source to one or more connected clients.

PublishingPointParameters

Provides configuration parameters for creating and managing a PublishingPoint.

SharedKeyToken

Provides shared key token generation and validation for secure API authentication.

StreamingServer

Represents the main streaming server that manages publishing points, protocol-specific sub-servers (RTMP, RTSP, SRT, WebRTC, HLS, MPEG-DASH, etc.), sources, sinks, and client connections.

StreamingServerStat

Collects and provides server performance statistics including CPU, memory, and GPU usage. This implementation is used on .NET Core and derives from EventListener.

TcpServerParameters

Provides configuration parameters for the VAST.Network.TcpServer.

VirtualNetworkSource

Represents a virtual network source that allows programmatic injection of media samples.

Interfaces

IApiControllableSource

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.

IMessaging

Defines the contract for messaging functionality that enables communication with remote peers.

INetworkEndPoint

Defines the contract for a network endpoint with connection and authorization information.

INetworkSink

Defines the contract for a network media sink that combines media sink functionality with network endpoint capabilities.

INetworkSource

Defines the contract for a network media source that combines media source functionality with network endpoint capabilities.

INetworkStat

Defines the contract for accessing network statistics information.

ITcpSource

Defines the interface for a TCP-based media source that receives data and disconnection notifications from a VAST.Network.TcpServer.

Enums

ClientType

Specifies the type of client connection to the streaming server.

ConnectionType

Specifies the type of a network connection to the streaming server.

ExtendedSocketError

Defines extended error codes for socket operations.

PublishingPoint.BufferingType

Specifies the buffering type used by a PublishingPoint.

PublishingPoint.ShutdownReason

Specifies the reason a PublishingPoint was shut down.

Delegates

PublishingPointParameters.StreamMapperDelegate

Delegate to create user defined stream mapping.

StreamingServer.AuthorizeHandler

Represents the method that handles the authorization event for a connection.

StreamingServer.ClientConnectedHandler

Represents the method that handles the event when a client has connected.

StreamingServer.DisconnectedHandler

Represents the method that handles the event when a connection is disconnected.

StreamingServer.ErrorHandler

Represents the method that handles the event when an error occurs.

StreamingServer.PublisherConnectedHandler

Represents the method that handles the event when a publisher has connected.

StreamingServer.PublishingPointDisposingHandler

Represents the method that handles the event when a publishing point is about to be disposed.

StreamingServer.PublishingPointRequestedHandler

Represents the method that handles the event when a publishing point is requested by a client.

StreamingServer.ReceivedCommandHandler

Represents the method that handles an unknown API command received by the server.