Getting Started

インストール

AIアシスタントによるセットアップを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを実行してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のコマンドを使用してください:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-ffmpeg` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してください。プラットフォーム固有の指示を以下に記載します。

bun add @capgo/capacitor-ffmpeg
bunx cap sync

Import

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

「APIの概要」のセクション

getCapabilities

現在のプラットフォームのマシン読み取り可能な能力マトリックスを返します。

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

await CapacitorFFmpeg.getCapabilities();

reencodeVideo

動画再エンコードジョブのキューを設定します。

iOSの場合、ネイティブレイヤーがジョブを受け入れると、返されたプロミスは解決されます。 最終的な成功または失敗はリスナーを通じて伝えられます。 progress AndroidとWebは現在拒否しています。

クリップボードにコピー UNIMPLEMENTED.

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

await CapacitorFFmpeg.reencodeVideo({} as ReencodeVideoOptions);

convertImage

iOSは現在

__CAPGO_KEEP_0__ jpeg と .png現在、Androidは .webp, jpeg、そして .pngコピー UNIMPLEMENTED.

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

await CapacitorFFmpeg.convertImage({} as ConvertImageOptions);

convertAudio

現在、iOSは

。現在、AndroidとWebは m4aコピー UNIMPLEMENTED.

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

await CapacitorFFmpeg.convertAudio({} as ConvertAudioOptions);

「型参照」

FFmpegCapabilitiesResult

export interface FFmpegCapabilitiesResult {
  platform: string;
  features: FFmpegCapabilitiesFeatures;
}

ReencodeVideoOptions

export interface ReencodeVideoOptions {
  inputPath: string;
  outputPath: string;
  width: number;
  height: number;
  bitrate?: number;
}

FFmpegAcceptedJob

export interface FFmpegAcceptedJob {
  jobId: string;
  status: 'queued';
}

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

export interface ConvertImageResult {
  outputPath: string;
  format: ImageOutputFormat;
}

ConvertAudioOptions

export interface ConvertAudioOptions {
  inputPath: string;
  outputPath: string;
  format: AudioOutputFormat;
}

ConvertAudioResult

export interface ConvertAudioResult {
  outputPath: string;
  format: AudioOutputFormat;
}

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

export interface PluginVersionResult {
  version: string;
}

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

export type ImageOutputFormat = '.webp' | 'jpeg' | '.png';

AudioOutputFormat

export type AudioOutputFormat = 'm4a';

ソース オブ トゥルース

このページはプラグインの src/definitions.tsパブリック API がアップストリームで変更されたときに再度同期を実行してください。

「始めてから続けて」

あなたが使用している場合 始めてから to plan dashboard and API operations, connect it with Using @capgo/capacitor-ffmpeg 「@capgo/capacitor-ffmpeg」を使用して 「@API/__CAPGO_KEEP_1__-ffmpeg」を使用して、native capability を使用してください。 Capgoの実装詳細についてはAPIの概要を参照してください。 概要 Capgoの実装詳細については概要を参照してください。 APIのキー Capgoの実装詳細についてはAPIのキー、 デバイス Capgoの実装詳細についてはデバイスを参照してください。