はじめから始める
インストール手順とこのプラグインの全マークダウンガイドを含むセットアップ用の質問をコピー
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-ffmpeg`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/ffmpeg/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Install
Section titled “Install”bun add @capgo/capacitor-ffmpegbunx cap syncImport
Section titled “Import”import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';API の概要
API の概要というセクションgetCapabilities
「getCapabilities」というタイトルのセクション現在のプラットフォームのマシン読み取り可能な能力マトリックスを返します。
import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';
await CapacitorFFmpeg.getCapabilities();reencodeVideo
__CAPGO_KEEP_0__ の概要というタイトルのセクション「reencodeVideo」というタイトルのセクション
ビデオ再エンコードジョブのキューを設定します。 progress iOSでは、ネイティブレイヤーがジョブを受け入れると、返されたプロミスが解決されます。
最終的な成功または失敗はリスナー経由で伝えられます。
AndroidとWebは現在拒否しています。 UNIMPLEMENTED.
import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';
await CapacitorFFmpeg.reencodeVideo({} as ReencodeVideoOptions);convertImage
「convertImage」セクション静止画像を別の形式に変換します。
iOSは現在 jpeg 、 .png。
Androidは現在 .webp, jpeg, .png。
Webは UNIMPLEMENTED.
import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';
await CapacitorFFmpeg.convertImage({} as ConvertImageOptions);convertAudio
「convertAudio」セクションオーディオを別のコンテナまたはエンコードに変換します。
iOSは現在 m4a。
AndroidとWebは UNIMPLEMENTED.
import { CapacitorFFmpeg } from '@capgo/capacitor-ffmpeg';
await CapacitorFFmpeg.convertAudio({} as ConvertAudioOptions);型式の参照
型式の参照FFmpegCapabilitiesResult
FFmpegCapabilitiesResultのセクションexport interface FFmpegCapabilitiesResult { platform: string; features: FFmpegCapabilitiesFeatures;}ReencodeVideoOptions
ReencodeVideoOptionsのセクションexport interface ReencodeVideoOptions { inputPath: string; outputPath: string; width: number; height: number; bitrate?: number;}FFmpegAcceptedJob
FFmpegAcceptedJobのセクションexport interface FFmpegAcceptedJob { jobId: string; status: 'queued';}ConvertImageOptions
ConvertImageOptionsのセクションexport interface ConvertImageOptions { inputPath: string; outputPath: string; format: ImageOutputFormat; /** * Compression quality in the inclusive range `0.0..1.0`. * * Native platforms reject values outside that range. */ quality?: number;}ConvertImageResult
ConvertImageResultのセクションexport interface ConvertImageResult { outputPath: string; format: ImageOutputFormat;}ConvertAudioOptions
「ConvertAudioOptions」セクションexport interface ConvertAudioOptions { inputPath: string; outputPath: string; format: AudioOutputFormat;}ConvertAudioResult
「ConvertAudioResult」セクションexport interface ConvertAudioResult { outputPath: string; format: AudioOutputFormat;}FFmpegProgressEvent
「FFmpegProgressEvent」セクションexport interface FFmpegProgressEvent { jobId: string; /** * Normalized progress as a floating-point value in the inclusive range `0.0..1.0`. */ progress: number; state: FFmpegProgressState; message?: string; outputPath?: string; /** * Legacy alias kept for compatibility while callers migrate to `jobId`. */ fileId?: string;}PluginVersionResult
「PluginVersionResult」セクションexport interface PluginVersionResult { version: string;}FFmpegCapabilitiesFeatures
「FFmpegCapabilitiesFeatures」セクションexport interface FFmpegCapabilitiesFeatures { getPluginVersion: FFmpegCapability; getCapabilities: FFmpegCapability; reencodeVideo: FFmpegCapability; convertImage: FFmpegCapability; convertAudio?: FFmpegCapability; progressEvents: FFmpegCapability; probeMedia: FFmpegCapability; generateThumbnail: FFmpegCapability; extractAudio: FFmpegCapability; remux: FFmpegCapability; trim: FFmpegCapability;}ImageOutputFormat
「ImageOutputFormat」セクションexport type ImageOutputFormat = '.webp' | 'jpeg' | '.png';AudioOutputFormat
「オーディオ出力形式」のセクションexport type AudioOutputFormat = 'm4a';真実の源
「真実の源」のセクションこのページはプラグインから生成されます。 src/definitions.tsパブリックのAPIがアップストリームで変更された場合に再度同期を実行してください。
「はじめから始める」の続き
「はじめから始める」の続きのセクションCapgoを使用している場合 「はじめから始める」を使用してダッシュボードと__CAPGO_KEEP_0__の操作を計画する場合、Capgoと接続してください。 to plan dashboard and API operations, connect it with Capacitorで使用する@capgo/capacitor-ffmpeg Capacitorで使用する@capgo/capacitor-ffmpegの APIの概要 Capacitorの実装詳細についてはAPIの概要を参照してください 導入 導入の実装詳細については導入を参照してください APIのキー Capacitorの実装詳細についてはAPIのキーを参照してください デバイス デバイスの実装詳細についてはデバイスを参照してください