Skip to content

KarinJS/karin-plugin-ffmpeg

Repository files navigation

@karinjs/plugin-ffmpeg

一个为 Karin 提供开箱即用的 FFmpeg 二进制文件的插件,运行时自动下载 FFmpeg。

📦 安装

pnpm add @karinjs/plugin-ffmpeg -w

运行时会从淘宝源镜像下载 FFmpeg、FFprobe 和 FFplay(仅 Windows)二进制文件。

🛠️ 开发

本地开发

# 安装依赖
pnpm install

# 开发模式
pnpm dev

# 构建
pnpm build
# 测试
pnpm test

使用方式

import ffmpeg from '@karinjs/plugin-ffmpeg'

const paths = await ffmpeg.ready()
console.log(paths.ffmpegPath)

const syncPaths = ffmpeg.readySync()
console.log(syncPaths.ffmpegPath)

项目结构

src/
├── index.ts        # 主入口,提供 FFmpeg 路径访问
└── types.ts        # TypeScript 类型定义

dist/               # 编译输出目录
├── index.mjs
└── index.d.mts

💡 常见问题

下载失败怎么办?

插件会自动从淘宝源镜像拉取可用版本并下载匹配平台的包,如果所有源都失败,请检查网络连接与镜像是否可访问。

运行时解压依赖系统 tar 命令,请确保系统可用。

FFmpeg 来源

本插件使用 KarinJS/FFmpeg-Builds 的构建产物,并通过淘宝源镜像下载。

下载源列表

下载镜像入口:

支持哪些平台?

  • Windows (x64, x86)
  • Linux (x64, arm64, i686)
  • macOS (暂不支持,构建产物不包含 darwin 目标)

存储位置

FFmpeg 二进制文件会下载到 ~/.cache/ffmpeg/ffmpeg-<platform>-<version>/ 目录中。

📄 许可证

MIT

🤝 贡献

欢迎提交 Issue 和 Pull Request!

About

为 Karin 提供开箱即用的 FFmpeg,免去给系统安装 FFmpeg 的繁琐步骤

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors