MCP tool to write BGM placement annotations to OTIO timeline. Records BGM volume, fade, and ducking instructions as metadata on A2 Audio track clips, which clipwright-render realizes as a mix.
Project description
clipwright-bgm
MCP tool to write BGM placement annotations to an OTIO timeline. Records BGM volume, fade, and ducking instructions as metadata on A2 Audio track clips, which clipwright-render realizes as a mix.
Overview
- Input: Timeline OTIO file, BGM audio file, output path, optional parameters (volume, fade, ducking)
- Process: OTIO manipulation only (no ffmpeg/external OSS). Adds BGM clip to A2 Audio track and writes clipwright metadata
- Output: New OTIO file with BGM annotations (input timeline immutable, M5)
MCP Tool
clipwright_add_bgm
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
timeline |
string |
required | Input timeline file path (existing .otio) |
bgm |
string |
required | BGM audio file path (mp3/wav/m4a/aac/flac/ogg/opus/mp4/mkv/mov/webm) |
output |
string |
required | Output OTIO file path (newly generated, different from input) |
options |
object |
null |
BgmOptions (volume_db / fade_in_sec / fade_out_sec / ducking) |
Dependencies
| Package | Purpose |
|---|---|
clipwright |
Shared types, envelope, errors, inspect_media |
mcp[cli] |
MCP server |
pydantic |
Parameter validation |
Installation and Startup
uv add clipwright-bgm
clipwright-bgm
Or within a uv workspace:
uv run --package clipwright-bgm clipwright-bgm
Prerequisites
- Python 3.11 or later
- ffprobe available on PATH or specified via
CLIPWRIGHT_FFPROBEenvironment variable (used to determine BGM media length)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file clipwright_bgm-0.1.1.tar.gz.
File metadata
- Download URL: clipwright_bgm-0.1.1.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a612ecbfb4ee3cf73ea6e203dbecc2f3bd1b361527e2c476939644bd659e087
|
|
| MD5 |
62d75f83f4118a35778fc80f927569a3
|
|
| BLAKE2b-256 |
c764e40cf6d2a5661ea7dfbedf85b459cc00f1c28ce6e96d02454280f3d39ce5
|
File details
Details for the file clipwright_bgm-0.1.1-py3-none-any.whl.
File metadata
- Download URL: clipwright_bgm-0.1.1-py3-none-any.whl
- Upload date:
- Size: 9.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f701b5f012be26b1153e4184183560f6a8e4f151171270ae33e7da8ad993ae9c
|
|
| MD5 |
f021f2f7fc5c7c9d21539363cd44bb88
|
|
| BLAKE2b-256 |
dca00b1314d7ea842c8ee20f690d0c318365b7df86fb7e59815944a24db53928
|
