Table of Contents

Class PlaybackParameters

Namespace
VAST.Media
Assembly
VAST.Common.dll

Represents configuration parameters for media playback.

public class PlaybackParameters
Inheritance
PlaybackParameters
Inherited Members

Constructors

PlaybackParameters() 

public PlaybackParameters()

Properties

AllowDigitalPTZ

Gets or sets a value indicating whether screen pan, tilt, and zoom are allowed.

public bool AllowDigitalPTZ { get; set; }

Property Value

bool

Remarks

The default value is false.

AllowHardwareAcceleration

Gets or sets a value indicating whether hardware acceleration is allowed for video decoders.

[Obsolete("Property is deprecated. Use VideoDecoderParameters instead.")]
public bool AllowHardwareAcceleration { get; set; }

Property Value

bool

Remarks

This setting applies to video decoders only. The default value is true.

AllowIncompleteMediaType

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

public bool? AllowIncompleteMediaType { get; set; }

Property Value

bool?

Remarks

If set to true, playback starts immediately even if one or more source media types are incomplete. Once a source media type becomes complete, rendering of that stream starts automatically. If a source media type never becomes complete, the stream rendering will never start. The default value is null (treated as false), meaning the player waits for complete media types before starting. This setting only applies if the source supports incomplete media types; otherwise, it has no effect.

AudioDecoderParameters

Gets or sets the audio decoding parameters.

public DecoderParameters AudioDecoderParameters { get; }

Property Value

DecoderParameters

AudioOutputDeviceId

Gets or sets the audio device ID of the WASAPI endpoint to be used for audio output.

public string AudioOutputDeviceId { get; set; }

Property Value

string

CleanupOnStop

Gets or sets a value indicating whether to clear the player window on stop.

public bool CleanupOnStop { get; set; }

Property Value

bool

Remarks

The default value is true, meaning the player window is filled with the background color on stop. Set to false to keep the last rendered image intact.

ForceKeyframeOnlyDecoding

Gets or sets a value indicating whether to decode keyframes only and skip P and B frames.

public bool ForceKeyframeOnlyDecoding { get; set; }

Property Value

bool

Remarks

This mode significantly decreases CPU and GPU load. The resulting video is not smooth, and the update interval depends on the GOP duration. For example, if the GOP is 3 seconds, the rendered image will be updated once every 3 seconds. The default value is false, meaning all frames are decoded.

MirrorX

Gets or sets a value indicating whether to flip the rendered image horizontally.

public bool MirrorX { get; set; }

Property Value

bool

Remarks

Supported only on select platforms. The default value is false.

MirrorY

Gets or sets a value indicating whether to flip the rendered image vertically.

public bool MirrorY { get; set; }

Property Value

bool

Remarks

Supported only on select platforms. The default value is false.

PreferredAudioFramework

Gets or sets the preferred media framework for audio decoder creation.

[Obsolete("Property is deprecated. Use AudioDecoderParameters instead.")]
public MediaFramework PreferredAudioFramework { get; set; }

Property Value

MediaFramework

Remarks

By default, the platform built-in framework is used. If Unknown is specified, every available framework will be tried.

PreferredVideoFramework

Gets or sets the preferred media framework for video decoder creation.

[Obsolete("Property is deprecated. Use VideoDecoderParameters instead.")]
public MediaFramework PreferredVideoFramework { get; set; }

Property Value

MediaFramework

Remarks

By default, the platform built-in framework is used. If Unknown is specified, every available framework will be tried.

RenderingStrategy

Gets or sets the rendering strategy.

public RenderingStrategy RenderingStrategy { get; set; }

Property Value

RenderingStrategy

Remarks

The default value is LowLatency.

StopAfterFirstFrame

Gets or sets a value indicating whether to stop playback after the first frame has been rendered.

public bool StopAfterFirstFrame { get; set; }

Property Value

bool

Remarks

The default value is false, meaning the stream continues playing.

StopAfterLastFrame

Gets or sets a value indicating whether to stop playback after the last frame has been rendered.

public bool StopAfterLastFrame { get; set; }

Property Value

bool

Remarks

The default value is true, meaning the MediaEnded event is invoked and the player state is reset. If set to false, the player invokes the MediaEnded event but transitions to the Paused state while displaying the last frame.

VideoDecoderParameters

Gets or sets the video decoding parameters.

public DecoderParameters VideoDecoderParameters { get; }

Property Value

DecoderParameters

VideoRendererType

Gets or sets the video renderer type.

public VideoRendererType VideoRendererType { get; set; }

Property Value

VideoRendererType

VideoRenderingFramerate

Gets or sets the maximum video rendering framerate.

public Rational VideoRenderingFramerate { get; set; }

Property Value

Rational

Remarks

This can be used on low-performance devices to reduce CPU/GPU load by setting a lower framerate than the input. The default value is null, meaning all frames are rendered.