Class Option

Represents an option in the FFmpeg library's configuration system.

Inheritance

object

Option

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: FFmpeg.Options

Assembly: FFmpeg.dll

Syntax

public sealed class Option

Remarks

This class provides access to the properties and metadata of an option, including its name, type, help text, and related flags.

Properties

Flags

Gets the flags associated with the option.

Declaration

public OptionFlags Flags { get; }

Property Value

Type	Description
OptionFlags

Remarks

Flags provide additional information about the option, such as whether it is read-only or affects specific media types.

HelpText

Gets the help text associated with the option.

Declaration

public string HelpText { get; }

Property Value

Type	Description
string

Remarks

The help text provides a description of the option's purpose and usage.

IsReadOnly

Gets a value indicating whether the option is read-only.

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
bool

Remarks

If this property returns true, the option cannot be modified after it is set.

Name

Gets the name of the option.

Declaration

public string Name { get; }

Property Value

Type	Description
string

Remarks

The name is used as an identifier for the option within the FFmpeg library.

OptionMediaType

Gets the media type associated with the option.

Declaration

public MediaType OptionMediaType { get; }

Property Value

Type	Description
MediaType

Remarks

This property determines whether the option is related to video, audio, subtitle, or an unknown media type based on its flags.

Type

Gets the type of the option.

Declaration

public OptionType Type { get; }

Property Value

Type	Description
OptionType

Remarks

The type indicates the kind of data the option accepts (e.g., integer, string, boolean).

Methods

ToString()

Returns a string representation of the option.

Declaration

public override string ToString()

Returns

Type	Description
string	The name of the option.

Overrides

object.ToString()