API Reference

Classes

`BeatAnalysisConfig`

Configuration for the beat-analysis subsystem.

`BeatAnalysisGenerationProvider`

Provider that registers a configured BeatAnalysisProvider backend.

__init__

def __init__(config: BeatAnalysisConfig | None = None) -> None

source

async def register(container: ContainerRegistrarProtocol) -> None

source

boot

async def boot(container: ContainerResolverProtocol) -> None

source

No async I/O needed at boot beyond what register() already did.

health_check

async def health_check(timeout: float = 5.0) -> HealthCheckResult

source

`BeatAnalysisModule`

source

Librosa/madmom tempo-and-beat-detection integration.

configure

def configure(
    cls,
    config: BeatAnalysisConfig | None = None
) -> DynamicModule

source

stub

def stub(
    cls,
    config: BeatAnalysisConfig | None = None
) -> DynamicModule

source

`LibrosaBeatAnalysisProvider`

source

Talks to no server — runs librosa's beat tracker in-process.

__init__

def __init__(sample_rate: int = 22050) -> None

source

analyze

async def analyze(request: BeatAnalysisRequest) -> Result[BeatAnalysisResult, MultimediaError]

source

`MadmomBeatAnalysisProvider`

source

Talks to a madmom_server.py reference server via BeatAnalysisProvider.

__init__

def __init__(
    base_url: str,
    timeout: float = 30.0,
    retry: RetryPolicyProtocol | None = None,
    circuit_breaker: CircuitBreakerProtocol | None = None
) -> None

source

analyze

async def analyze(request: BeatAnalysisRequest) -> Result[BeatAnalysisResult, MultimediaError]

source

Exceptions

`BeatAnalysisDecodeError`

source

Librosa could not decode the materialized audio file.