Class SinkParameters

Namespace

VAST.Media

Assembly

VAST.Common.dll

Defines configuration parameters for media sink initialization and operation.

public class SinkParameters

Inheritance

object

SinkParameters

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SinkParameters()

public SinkParameters()

Properties

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 sinks that support stream statistics. If not explicitly specified (null), the behavior depends on the default sink setting, which varies from sink to sink.

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.

AudioTranscoding

Gets or sets the audio transcoding mode.

public MediaTranscodingMode AudioTranscoding { get; set; }

Property Value

MediaTranscodingMode

Remarks

This property is only applied to sinks supporting transcoding and is ignored otherwise. The default value PassThrough means no transcoding.

MaxVideoFramerate

Gets or sets the maximum video framerate that the sink should push to clients.

public Rational MaxVideoFramerate { get; set; }

Property Value

Rational

Remarks

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

MaxVideoHeight

Gets or sets the maximum video height that the sink should push to clients.

public int MaxVideoHeight { get; set; }

Property Value

int

Remarks

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

MaxVideoWidth

Gets or sets the maximum video width that the sink should push to clients.

public int MaxVideoWidth { get; set; }

Property Value

int

Remarks

This property is only applied to sinks 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 sinks that support stream statistics. The behavior depends on the AllowStreamStat value:

• If null: behavior depends on the default sink 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.

VideoTranscoding

Gets or sets the video transcoding mode.

public MediaTranscodingMode VideoTranscoding { get; set; }

Property Value

MediaTranscodingMode

Remarks

This property is only applied to sinks supporting transcoding and is ignored otherwise. The default value PassThrough means no transcoding.