Parse ffmpeg filter documents from the official ffmpeg documentation.
Functions:
| Name | Description |
|---|---|
download_ffmpeg_filter_documents |
Download ffmpeg filter documents. |
extract_docs |
Extract ffmpeg filter document. |
process_docs |
Process ffmpeg filter documents. |
download_ffmpeg_filter_documents() -> Path
Download ffmpeg filter documents.
Returns:
| Type | Description |
|---|---|
Path
|
Path to the downloaded document |
extract_docs(filter_name: str) -> FilterDocument
Extract ffmpeg filter document.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filter_name
|
str
|
The name of the filter |
required |
Returns:
| Type | Description |
|---|---|
FilterDocument
|
FilterDocument object |
Raises:
| Type | Description |
|---|---|
ValueError
|
If the filter is not found. |
cached
¶
process_docs() -> list[FilterDocument]
Process ffmpeg filter documents.
Returns:
| Type | Description |
|---|---|
list[FilterDocument]
|
List of FilterDocument objects |