Skip to content

cli

Code generation CLI for typed-ffmpeg.

Functions:

Name Description
gen_filter_info

Generate filter info.

generate

Generate filter and option documents.

load_av_option_set

Load AV options from the output path.

load_codecs

Load codecs from the output path.

load_filters

Load filters from the output path.

load_formats

Load muxers from the output path.

load_options

Load options from the output path.

gen_filter_info

gen_filter_info(
    ffmpeg_filter: FFMpegFilter,
) -> FFMpegFilter

Generate filter info.

Parameters:

Name Type Description Default
ffmpeg_filter FFMpegFilter

The filter

required

Returns:

Type Description
FFMpegFilter

The filter info

generate

generate(
    outpath: Path | None = None, rebuild: bool = False
) -> None

Generate filter and option documents.

Parameters:

Name Type Description Default
outpath Path | None

The output path

None
rebuild bool

Whether to rebuild the filters and options from scratch, ignoring the cache

False

load_av_option_set

load_av_option_set(rebuild: bool) -> list[FFMpegAVOption]

Load AV options from the output path.

Parameters:

Name Type Description Default
rebuild bool

Whether to use the cache

required

Returns:

Type Description
list[FFMpegAVOption]

The options

load_codecs

load_codecs(rebuild: bool) -> list[FFMpegCodec]

Load codecs from the output path.

Parameters:

Name Type Description Default
rebuild bool

Whether to use the cache

required

Returns:

Type Description
list[FFMpegCodec]

The codecs

Raises:

Type Description
ValueError

If a codec is invalid.

load_filters

load_filters(rebuild: bool) -> list[FFMpegFilter]

Load filters from the output path.

Parameters:

Name Type Description Default
rebuild bool

Whether to use the cache

required

Returns:

Type Description
list[FFMpegFilter]

The filters

load_formats

load_formats(rebuild: bool) -> list[FFMpegFormat]

Load muxers from the output path.

Parameters:

Name Type Description Default
rebuild bool

Whether to use the cache

required

Returns:

Type Description
list[FFMpegFormat]

The muxers

Raises:

Type Description
ValueError

If a format is invalid.

load_options

load_options(rebuild: bool) -> list[FFMpegOption]

Load options from the output path.

Parameters:

Name Type Description Default
rebuild bool

Whether to use the cache

required

Returns:

Type Description
list[FFMpegOption]

The option info