Struct InputFormat

Represents an AV input format, wrapping around an FFmpeg.AutoGen._AVInputFormat pointer.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: FFmpeg.Formats

Assembly: FFmpeg.dll

Syntax

public readonly struct InputFormat

Remarks

This struct provides access to the properties and methods associated with an AV input format.

Properties

View Source

AAC

Gets the AAC input format.

Declaration

public static InputFormat? AAC { get; }

Property Value

Type	Description
InputFormat?

View Source

AAX

Gets the CRI AAX input format.

Declaration

public static InputFormat? AAX { get; }

Property Value

Type	Description
InputFormat?

View Source

AC3

Gets the raw AC-3 input format.

Declaration

public static InputFormat? AC3 { get; }

Property Value

Type	Description
InputFormat?

View Source

ASF

Gets the ASF input format.

Declaration

public static InputFormat? ASF { get; }

Property Value

Type	Description
InputFormat?

View Source

ASS

Gets the SSA/ASS subtitle input format.

Declaration

public static InputFormat? ASS { get; }

Property Value

Type	Description
InputFormat?

View Source

AVI

Gets the AVI input format.

Declaration

public static InputFormat? AVI { get; }

Property Value

Type	Description
InputFormat?

View Source

BMP_PIPE

Gets the piped BMP sequence input format.

Declaration

public static InputFormat? BMP_PIPE { get; }

Property Value

Type	Description
InputFormat?

View Source

DASH

Gets the DASH input format.

Declaration

public static InputFormat? DASH { get; }

Property Value

Type	Description
InputFormat?

View Source

DirectShow

Gets the direct show input device.

Declaration

public static InputFormat? DirectShow { get; }

Property Value

Type	Description
InputFormat?

View Source

Extensions

Gets the file extensions associated with the input format.

Declaration

public IReadOnlyList<string> Extensions { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

File extensions are used to identify files of this format. This property retrieves and splits the extensions from a comma-separated string. Returns an empty list if no extensions are available.

View Source

FLAC

Gets the FLAC input format.

Declaration

public static InputFormat? FLAC { get; }

Property Value

Type	Description
InputFormat?

View Source

FLV

Gets the Flash Video input format.

Declaration

public static InputFormat? FLV { get; }

Property Value

Type	Description
InputFormat?

View Source

Flags

Gets the flags associated with the input format.

Declaration

public FormatFlags Flags { get; }

Property Value

Type	Description
FormatFlags

Remarks

Flags represent various properties and capabilities of the format, such as whether it supports seeking or demuxing.

View Source

GDIScreenGrabber

Gets the dgigrap input device.
Use "desktop", title=window_title or hwnd=window_hwnd to specify what to grap.

Declaration

public static InputFormat? GDIScreenGrabber { get; }

Property Value

Type	Description
InputFormat?

View Source

HLS

Gets the HTTP Live Streaming input format.

Declaration

public static InputFormat? HLS { get; }

Property Value

Type	Description
InputFormat?

View Source

JPEGXL_PIPE

Gets the piped JPEG XL sequence input format.

Declaration

public static InputFormat? JPEGXL_PIPE { get; }

Property Value

Type	Description
InputFormat?

View Source

JPEG_PIPE

Gets the piped JPEG sequence input format.

Declaration

public static InputFormat? JPEG_PIPE { get; }

Property Value

Type	Description
InputFormat?

View Source

LongName

Gets the long name of the input format.

Declaration

public string LongName { get; }

Property Value

Type	Description
string

Remarks

The long name provides a more descriptive name for the format compared to the short names.

View Source

M4A

Gets the M4A input format (alias for MP4/MOV).

Declaration

public static InputFormat? M4A { get; }

Property Value

Type	Description
InputFormat?

View Source

MATROSKA

Gets the Matroska/WebM input format (alias for MKV/WebM).

Declaration

public static InputFormat? MATROSKA { get; }

Property Value

Type	Description
InputFormat?

View Source

MKV

Gets the Matroska/WebM input format.

Declaration

public static InputFormat? MKV { get; }

Property Value

Type	Description
InputFormat?

View Source

MOV

Gets the MOV input format (alias for MP4).

Declaration

public static InputFormat? MOV { get; }

Property Value

Type	Description
InputFormat?

View Source

MP3

Gets the MP3 input format (MP2/MP3).

Declaration

public static InputFormat? MP3 { get; }

Property Value

Type	Description
InputFormat?

View Source

MP4

Gets the MP4 input format (QuickTime / MOV / MP4 / 3GP / M4A / 3G2 / MJ2).

Declaration

public static InputFormat? MP4 { get; }

Property Value

Type	Description
InputFormat?

View Source

MPEG

Gets the MPEG-PS input format.

Declaration

public static InputFormat? MPEG { get; }

Property Value

Type	Description
InputFormat?

View Source

MPEGTS

Gets the MPEG-TS input format.

Declaration

public static InputFormat? MPEGTS { get; }

Property Value

Type	Description
InputFormat?

View Source

MimeTypes

Gets the MIME types associated with the input format.

Declaration

public IReadOnlyList<string> MimeTypes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

MIME types are used to indicate the media type of the format. This property retrieves and splits the MIME types from a comma-separated string. Returns an empty list if no MIME types are available.

View Source

OGA

Gets the Ogg input format (alias for Ogg).

Declaration

public static InputFormat? OGA { get; }

Property Value

Type	Description
InputFormat?

View Source

OGG

Gets the Ogg input format.

Declaration

public static InputFormat? OGG { get; }

Property Value

Type	Description
InputFormat?

View Source

OGV

Gets the Ogg input format (alias for Ogg).

Declaration

public static InputFormat? OGV { get; }

Property Value

Type	Description
InputFormat?

View Source

PNG_PIPE

Gets the piped PNG sequence input format.

Declaration

public static InputFormat? PNG_PIPE { get; }

Property Value

Type	Description
InputFormat?

View Source

RAWVIDEO

Gets the raw video input format.

Declaration

public static InputFormat? RAWVIDEO { get; }

Property Value

Type	Description
InputFormat?

View Source

RTP

Gets the RTP input format.

Declaration

public static InputFormat? RTP { get; }

Property Value

Type	Description
InputFormat?

View Source

RTSP

Gets the RTSP input format.

Declaration

public static InputFormat? RTSP { get; }

Property Value

Type	Description
InputFormat?

View Source

SRT

Gets the SubRip subtitle input format.

Declaration

public static InputFormat? SRT { get; }

Property Value

Type	Description
InputFormat?

View Source

SSA

Gets the SSA subtitle input format (alias for ASS).

Declaration

public static InputFormat? SSA { get; }

Property Value

Type	Description
InputFormat?

View Source

ShortNames

Gets the short names associated with the input format.

Declaration

public IEnumerable<string> ShortNames { get; }

Property Value

Type	Description
IEnumerable<string>

Remarks

Short names are often used as identifiers or abbreviations for the format. This property retrieves and splits the short names from a comma-separated string.

View Source

SupportedCodecs

Gets the list of supported codecs for this input format.

Declaration

public IReadOnlyList<CodecTag> SupportedCodecs { get; }

Property Value

Type	Description
IReadOnlyList<CodecTag>

Remarks

This property iterates through the codec tags associated with the format to collect the supported codec IDs.

View Source

TIFF_PIPE

Gets the piped TIFF sequence input format.

Declaration

public static InputFormat? TIFF_PIPE { get; }

Property Value

Type	Description
InputFormat?

View Source

WAV

Gets the WAV input format.

Declaration

public static InputFormat? WAV { get; }

Property Value

Type	Description
InputFormat?

View Source

WEBM

Gets the WebM input format (alias for Matroska).

Declaration

public static InputFormat? WEBM { get; }

Property Value

Type	Description
InputFormat?

View Source

WEBP_PIPE

Gets the piped WEBP sequence input format.

Declaration

public static InputFormat? WEBP_PIPE { get; }

Property Value

Type	Description
InputFormat?

View Source

WMA

Gets the WMA input format (inside ASF).

Declaration

public static InputFormat? WMA { get; }

Property Value

Type	Description
InputFormat?

View Source

YUV4MPEGPIPE

Gets the YUV4MPEG input format.

Declaration

public static InputFormat? YUV4MPEGPIPE { get; }

Property Value

Type	Description
InputFormat?

Methods

View Source

FindFormat(string)

Finds an InputFormat by its short name.

Declaration

public static InputFormat? FindFormat(string short_name)

Parameters

Type	Name	Description
string	short_name	The short name of the input format to find.

Returns

Type	Description
InputFormat?	An instance of InputFormat if found; otherwise, null.

View Source

GetInputFormats()

Retrieves a collection of all available AV input formats.

Declaration

public static IReadOnlyList<InputFormat> GetInputFormats()

Returns

Type	Description
IReadOnlyList<InputFormat>	An IReadOnlyList<T> containing all available input formats.

Remarks

This method uses the FFmpeg library to iterate through all available demuxers and collects them into a list of InputFormat objects.

View Source

ToString()

Returns a string representation of the input format.

Declaration

public override string ToString()

Returns

Type	Description
string	The LongName of the input format.

Overrides

ValueType.ToString()