Table of Contents

Class MediaBlockAvailabilityResult

Namespace
VisioForge.Core.MediaBlocks.Catalog
Assembly
VisioForge.Core.dll

The result of probing one block's availability on the current machine.

public class MediaBlockAvailabilityResult

Inheritance

Inherited Members

Constructors

MediaBlockAvailabilityResult(MediaBlockAvailabilityState, string, string)

Initializes a new instance of the VisioForge.Core.MediaBlocks.Catalog.MediaBlockAvailabilityResult class.

public MediaBlockAvailabilityResult(MediaBlockAvailabilityState state, string reason = null, string message = null)

Parameters

state MediaBlockAvailabilityState

The availability state.

reason string

A machine-readable reason code, required when not available.

message string

A user-facing English explanation.

Fields

Available

A shared result for blocks that are always usable.

public static readonly MediaBlockAvailabilityResult Available

Field Value

MediaBlockAvailabilityResult

Properties

Message

Gets the user-facing English explanation. Null when available.

public string Message { get; }

Property Value

string

Reason

Gets the machine-readable reason code, for example gst_element_missing. Null when available.

public string Reason { get; }

Property Value

string

State

Gets the availability state.

public MediaBlockAvailabilityState State { get; }

Property Value

MediaBlockAvailabilityState

Methods

MissingElement(string)

Creates an unavailable result for a missing GStreamer element.

public static MediaBlockAvailabilityResult MissingElement(string elementName)

Parameters

elementName string

The missing GStreamer element name.

Returns

MediaBlockAvailabilityResult