Skip to content

cli

Manual configuration CLI for typed-ffmpeg.

Functions:

Name Description
init_config

Initialize manual configuration files for filters.

load_config

Load manual configuration for a specific filter.

migrate_config

Migrate legacy configuration files to the current schema format.

init_config

init_config() -> None

Initialize manual configuration files for filters.

This command creates default manual configuration files for all filters that have dynamic inputs or outputs. These configuration files can then be manually edited to provide custom typing information for complex filters.

load_config

load_config(
    name: str,
) -> FFMpegFilterManuallyDefined | None

Load manual configuration for a specific filter.

This function attempts to load the manual configuration for a given filter by name. If the configuration exists in the cache, it returns the configuration object. If no configuration is found, it returns None.

Parameters:

Name Type Description Default
name str

The name of the filter to load configuration for

required

Returns:

Type Description
FFMpegFilterManuallyDefined | None

The filter's manual configuration if found, None otherwise

migrate_config

migrate_config() -> None

Migrate legacy configuration files to the current schema format.

This command is meant to be run only once when transitioning from an older version of the schema format to the current one. It locates legacy JSON schema files, extracts relevant information, and saves them in the new format.

Note: This function is not covered by tests as it's a one-time migration utility.