Class DecoderParameters

Namespace

VAST.Media

Assembly

VAST.Common.dll

Defines configuration parameters for media decoder creation and initialization.

public class DecoderParameters

Inheritance

object

DecoderParameters

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DecoderParameters()

public DecoderParameters()

Properties

AllowHardwareAcceleration

Gets or sets whether hardware acceleration will be allowed for decoder. By default DefaultAllowHardwareAcceleration is used.

public bool AllowHardwareAcceleration { get; set; }

Property Value

bool

DefaultAllowHardwareAcceleration

Gets or sets whether hardware acceleration will be allowed for decoder by default. By default hardware acceleration is enabled.

public static bool DefaultAllowHardwareAcceleration { get; set; }

Property Value

bool

DefaultPreferredAudioFramework

Gets or sets default preferred audio framework for decoder creation. By default platform built-in framework is used. If Unknown is chosen as a value then every available framework will be tried.

public static MediaFramework? DefaultPreferredAudioFramework { get; set; }

Property Value

MediaFramework?

DefaultPreferredMediaFramework

Gets or sets default preferred media framework for decoder creation. By default platform built-in framework is used. If Unknown is chosen as a value then every available framework will be tried.

public static MediaFramework DefaultPreferredMediaFramework { get; set; }

Property Value

MediaFramework

DefaultPreferredVideoFramework

Gets or sets default preferred video framework for decoder creation. By default platform built-in framework is used. If Unknown is chosen as a value then every available framework will be tried.

public static MediaFramework? DefaultPreferredVideoFramework { get; set; }

Property Value

MediaFramework?

DeviceIndex

Gets or sets device index to use for decoding if there are more than one device in the system. Only supported for Nvidia GPUs at the moment. If not specified then random device will be chosen.

public int DeviceIndex { get; set; }

Property Value

int

PreferredMediaFramework

Gets or sets preferred media framework for decoder creation. By default DefaultPreferredMediaFramework framework is used. If Unknown is chosen as a value then every available framework will be tried.

public MediaFramework PreferredMediaFramework { get; set; }

Property Value

MediaFramework

ProcessingErrorHandling

Gets or sets how the decoder should handle errors that occur during media processing.

public DecoderProcessingErrorHandling ProcessingErrorHandling { get; set; }

Property Value

DecoderProcessingErrorHandling

Remarks

The property is currently supported by AndroidDecoder only and is ignored by other decoders!

The available options are:

• Ignore - Silently ignore the error and continue processing subsequent frames (default).
• Recreate - Recreate the decoder instance to recover from the error.
• Throw - Throw a VAST.Media.DecoderException to signal the error to the caller.

Methods

Clone()

Creates a deep copy of this instance.

public DecoderParameters Clone()

Returns

DecoderParameters

A new DecoderParameters instance with copied values.