跳转至正文

FFmpeg Capacitor 插件

基于 FFmpeg 的视频编码与处理,支持压缩与格式转换

安装

bun add @capgo/capacitor-ffmpeg bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-ffmpeg
  • pnpm add @capgo/capacitor-ffmpeg
  • yarn add @capgo/capacitor-ffmpeg

指南

如何在 Capacitor 中使用 FFmpeg

使用 @capgo/capacitor-ffmpeg

将 FFmpeg API 暴露给 Capacitor。

安装

bun add @capgo/capacitor-ffmpeg
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

API 概览

方法 描述
getCapabilities 返回当前平台的机器可读能力矩阵。
reencodeVideo 将视频转码任务加入队列。
convertImage 将静态图像转换为其他格式。
convertAudio 将音频转换为其他封装格式或编解码器。

示例

getCapabilities()

返回当前平台的机器可读能力矩阵。

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const result = await CapacitorFFmpeg.getCapabilities();
console.log(result);

reencodeVideo()

将视频转码任务加入队列。

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const result = await CapacitorFFmpeg.reencodeVideo({
  inputPath: 'path/to/file',
  outputPath: 'path/to/file',
  width: 1080,
  height: 1920,
});
console.log(result);

convertImage()

将静态图像转换为其他格式。

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const result = await CapacitorFFmpeg.convertImage({
  inputPath: 'path/to/file',
  outputPath: 'path/to/file',
  format: 'webp',
});
console.log(result);

convertAudio()

将音频转换为其他封装格式或编解码器。

import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';

const result = await CapacitorFFmpeg.convertAudio({
  inputPath: 'path/to/file',
  outputPath: 'path/to/file',
  format: 'm4a',
});
console.log(result);

监听事件

addListener 会返回一个句柄。调用 handle.remove() 当屏幕卸载时。

完整参考文档

继续使用 @capgo/capacitor-ffmpeg

如果你正在使用 使用 @capgo/capacitor-ffmpeg 要规划 dashboard 和 API 操作,请将其连接到 @capgo/capacitor-ffmpeg 有关 @capgo/capacitor-ffmpeg 的实现细节, 快速入门 有关“入门指南”中的实现细节, API 概览 关于 API Overview 中的实现细节, 简介 关于简介中的实现细节,以及 API 密钥 关于 API Keys 中的实现细节。

常见问题

FFmpeg 插件常见问题

如何在 Capacitor 应用中安装 FFmpeg 插件?

运行 "bun add @capgo/capacitor-ffmpeg" (或 "npm install @capgo/capacitor-ffmpeg"),然后运行 "bunx cap sync",使 iOS 和 Android 项目同步 native code。最后在你的应用 code 中从 "@capgo/capacitor-ffmpeg" 导入即可。

@capgo/capacitor-ffmpeg 是否支持 React、Vue 和 Angular?

是的。FFmpeg 是一个 Capacitor 插件,因此它可以与任何在 Capacitor 中运行的 Web 框架配合使用,包括 Ionic、React、Vue、Angular、Svelte 以及原生 JavaScript。

@capgo/capacitor-ffmpeg 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-ffmpeg 是免费开源的吗?

是的。code 的源代码已在 GitHub 上公开,地址为 https://github.com/Cap-go/capacitor-ffmpeg/,并且可以通过 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我可以在不经过 App Store 审核的情况下,更新使用了 FFmpeg 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App Store 审核,即可快速发布 FFmpeg 更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo