Class SourceParameters

Namespace

VAST.Media

Assembly

VAST.Common.dll

Defines configuration parameters for media source initialization and operation.

public class SourceParameters

Inheritance

object

SourceParameters

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SourceParameters()

public SourceParameters()

Properties

AllowIncompleteMediaType

Gets or sets a value indicating whether incomplete media types should be allowed when starting a source.

public bool? AllowIncompleteMediaType { get; set; }

Property Value

bool?

Remarks

If set to true, the source will transition to the Opened state even if one or more media types are incomplete. Once a media type becomes complete, it will be attached to the stream sample. The default value is null (treated as false), meaning the source waits for complete media types before transitioning to Opened. This property only applies if the source exposes the SupportIncompleteMediaType capability; otherwise, it has no effect.

AllowStreamStat

Gets or sets a value indicating whether stream statistics should appear in the log.

public bool? AllowStreamStat { get; set; }

Property Value

bool?

Remarks

This property is only relevant for sources that support stream statistics (e.g., capture sources, ProxySource). If not explicitly specified (null), the behavior depends on the default source setting, which varies from source to source.

AudioDecoderParameters

Gets or sets the audio decoding parameters.

public DecoderParameters AudioDecoderParameters { get; set; }

Property Value

DecoderParameters

Remarks

This property is only relevant if audio decoding is expected.

AudioEncoderParameters

Gets or sets the audio encoding parameters.

public EncoderParameters AudioEncoderParameters { get; set; }

Property Value

EncoderParameters

Remarks

This property is only relevant if encoded audio output is expected.

MaxVideoFramerate

Gets or sets the maximum video framerate that the source should output.

public Rational MaxVideoFramerate { get; set; }

Property Value

Rational

Remarks

This property is only applied to sources supporting transcoding and is ignored otherwise. The default value of null means no limit.

MaxVideoHeight

Gets or sets the maximum video height that the source should output.

public int MaxVideoHeight { get; set; }

Property Value

int

Remarks

This property is only applied to sources supporting transcoding and is ignored otherwise. The default value of 0 means no limit.

MaxVideoWidth

Gets or sets the maximum video width that the source should output.

public int MaxVideoWidth { get; set; }

Property Value

int

Remarks

This property is only applied to sources supporting transcoding and is ignored otherwise. The default value of 0 means no limit.

StreamStatInterval

Gets or sets the interval at which stream statistics are logged.

public TimeSpan StreamStatInterval { get; set; }

Property Value

TimeSpan

Remarks

This property is only relevant for sources that support stream statistics (e.g., capture sources, ProxySource). The behavior depends on the AllowStreamStat value:

• If null: behavior depends on the default source setting.
• If false: statistics never appear in the log.
• If true: statistics appear at the specified interval.

VideoDecoderParameters

Gets or sets the video decoding parameters.

public DecoderParameters VideoDecoderParameters { get; set; }

Property Value

DecoderParameters

Remarks

This property is only relevant if video decoding is expected.

VideoEncoderParameters

Gets or sets the video encoding parameters.

public EncoderParameters VideoEncoderParameters { get; set; }

Property Value

EncoderParameters

Remarks

This property is only relevant if encoded video output is expected.