schema

Schema definitions for parsing FFmpeg filter documentation.

Classes:

Name	Description
FilterDocument	A filter document.

FilterDocument dataclass

FilterDocument(
    *,
    section_index: str,
    hash: str,
    title: str,
    body: str,
    filter_names: tuple[str, ...]
)

A filter document.

Attributes:

Name	Type	Description
body	str	The body of the filter document
description	str	The description of the filter document in Markdown.
filter_names	tuple[str, ...]	The names of the filter (e.g. "acue")
hash	str	The hash of the filter
parameter_descs	dict[str, str]	The parameter descriptions of the filter document in Markdown.
section_index	str	The section index of the filter document (e.g. "8.8")
title	str	The title of the filter document (e.g. "8.8 acue")
url	str	The URL of the filter document.

body instance-attribute

body: str

The body of the filter document

description cached property

description: str

The description of the filter document in Markdown.

Returns:

Type	Description
str	The description of the filter document

filter_names instance-attribute

filter_names: tuple[str, ...]

The names of the filter (e.g. "acue")

hash instance-attribute

hash: str

The hash of the filter

parameter_descs cached property

parameter_descs: dict[str, str]

The parameter descriptions of the filter document in Markdown.

Returns:

Type	Description
dict[str, str]	The parameter descriptions of the filter document

section_index instance-attribute

section_index: str

The section index of the filter document (e.g. "8.8")

title instance-attribute

title: str

The title of the filter document (e.g. "8.8 acue")

url property

url: str

The URL of the filter document.

Returns:

Type	Description
str	The URL of the filter document